CircleCI Orb

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.

The first step in adding our orb to your configuration is to declare it in your CircleCI configuration.

version: 2.1
packtracker: packtracker/report@2.2.0

If you started using CircleCI prior to 2.1, you must enable pipelines within your project configuration to be able to use the orbs configuration.


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.


Now that you've declared our orb for use and added your project token, you have access to our report job. You can put this job anywhere inside your existing CircleCI workflows, or create a new workflow.

- packtracker/report

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.




The relative path to the directory containing the package.json of your project. By default, this is the root of your repository. This can be especially useful for projects that do not live at the root of the repository, like lerna mono-repositories for example.


The relative path to your webpack configuration. By default, it looks in the root directory for webpack.config.js.

For example, a Ruby on Rails project might look something like this.

- packtracker/report:
webpack_config: "./config/webpack/production.js"