Code Monkey home page Code Monkey logo

circleci-api-helper's Introduction

Node.js helper ๐Ÿ“ฆ for CircleCI API (v2)

npm version CircleCI tested with jest Downloads License: MIT

Background

This util allows you to trigger circleci workflows within a node js application. You can run specific workflow as part of circleci api v2

Install

yarn add circleci-api-helper

How to use

Files in CI or local that the helper uses for requests to the CircelCI API (v2)

/utils/circleToken.js (Required)
/utils/projectSlug.js (Required)
/utils/workflowName.js (Required)
/utils/workflowID.js

Example values

circleToken: FAKEGUID3adas23d69e532432d3x1f534852fs52
projectSlug: gh/johnhiggs/circleci-api-helper
workflowName: default-flow

Trigger workflow

(auto generates latest workflow ID based off of required values (requires circleToken, projectSlug, & workflowName)

yarn runWorkflow

Rerun existing workflow

Simply rerun an existing workflow (set a value to /utils/workflowID.js) yarn runSpecificWorkflow

circleci-api-helper's People

Contributors

dependabot[bot] avatar hiqqs avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.