diff --git a/README.md b/README.md index ffab75a..e89c94a 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,10 @@ For bug reports, please [open an issue on GitHub](https://github.com/rollbar/rol ## Contributing +For details on how to do development work on a CircleCI orb, check out [Circle CI's Orb docs](https://circleci.com/docs/2.0/creating-orbs/). + +To contribute to the Rollbar orb: + 1. [Fork it](https://github.com/rollbar/rollbar-orb) 2. Create your feature branch (```git checkout -b my-new-feature```). 3. Commit your changes (```git commit -am 'Added some feature'```) diff --git a/src/rollbar/orb.yml b/src/rollbar/orb.yml index 384dad1..6c7d394 100644 --- a/src/rollbar/orb.yml +++ b/src/rollbar/orb.yml @@ -2,7 +2,7 @@ version: 2.1 description: | Commands for calling the Rollbar deploy API. - Requires `curl` and `jq` commands to be available + Requires `curl` and `jq` commands to be available. The source for the Orb can be found here: https://github.com/rollbar/rollbar-orb/tree/master/src/rollbar @@ -10,13 +10,13 @@ commands: notify_deploy_started: description: | A step to notify Rollbar that the deploy of a project has started. - Should be used in conjunction with notify_deploy_succeeded or notify_deploy_failed. - Command will set a BASH ENV variable ROLLBAR_DEPLOY_ID with the ID of the deploy + Should be used in conjunction with notify_deploy_finished. + Command will set a BASH ENV variable ROLLBAR_DEPLOY_ID with the ID of the deploy. parameters: environment: type: string default: production - description: The Rollbar enviaronment. Defaults to production. + description: The Rollbar environment. Defaults to production. steps: - run: name: Rollbar - Notify Deploy Started @@ -51,7 +51,7 @@ commands: notify_deploy: description: | - A step to notify Rollbar the project has been successfully deployed. + A step to notify Rollbar that the project has been successfully deployed. A Rollbar access token is required to be set in the environment with the name `ROLLBAR_ACCESS_TOKEN`. Add this as the last step of your the job that you