CircleCI Orbs are reusable bits of configuration, we've combined this with a standard Docker image to provide a turn key solution for CircleCI users. No need to modify your project at all.
In order to use the CircleCI Orb, you must first opt-in your organization to allow third party orbs within your Organization Security settings. You can do this by going to Settings > Organization > Security
Next, you will add our orb to your configuration by declaring it in your CircleCI configuration.
If you started using CircleCI prior to 2.1, you must enable pipelines within your project configuration to be able to use the
In order for us to know what project you are reporting stats for, you must send along your packtracker project token. To do this with the CircleCI Orb, you must create a new project environment variable in your CircleCI settings called
PT_PROJECT_TOKEN. You can find your packtracker project token in your project's settings.
If you are not yet using CircleCI Workflows, you will need to do so. If this is the case, you likely have a single
buildjob in your CircleCI configuration. In order to add the packtracker
jobto your CI run, you will need to set up a multi-job workflow as seen in this example configuration.
Now that you've declared our orb for use and added your project token, you have access to our
reportjob. You can put this job anywhere inside your existing CircleCI workflows.
Or, create a new workflow to run packtracker reporting.
By default, this base configuration should just work most of the time. If you have a non-standard setup, you can tweak the job with the following 2 optional parameters.
For example, a Ruby on Rails project might look something like this.