orb.yml

version: 2.1
description: Send webpack bundle stats to packtracker for analysis.
display:
  source_url: https://github.com/packtracker/report
  home_url: https://packtracker.io/

executors:
  reporter:
    resource_class: << parameters.selected_resource_class >>
    docker:
      - image: packtracker/report:2.3.0
    parameters:
      selected_resource_class:
        description: Resource class to be used for the executor
        type: enum
        default: medium
        enum: [small, medium, medium+, large, xlarge, 2xlarge, 2xlarge+]

jobs:
  report:
    description: |
      This job reports your webpack bundle stats to the packtracker.io service.

      For this job to be able to authenticate with the packtracker service, you must additionally
      add the `PT_PROJECT_TOKEN` environment variable to your CircleCI project configuration.
      The project token can be found in the packtracker project settings.
    parameters:
      selected_resource_class:
        description: Resource class to be used for the executor
        type: enum
        default: medium
        enum: [small, medium, medium+, large, xlarge, 2xlarge, 2xlarge+]
      project_root:
        description: The path to the directory containing your package.json
        type: string
        default: ""
      webpack_config:
        description: The path to your webpack configuration file (if present)
        type: string
        default: "./webpack.config.js"
      exclude_assets:
        description: Compiled as RegExp and passed as the [excludeAssets configuration in the webpack stats config](https://webpack.js.org/configuration/stats/#stats) (only available to webpack version 3.5.0+)
        type: string
        default: ""
    environment:
      PT_EXCLUDE_ASSETS: << parameters.exclude_assets >>
      PT_PROJECT_ROOT: << parameters.project_root >>
      WEBPACK_CONFIG_PATH: << parameters.webpack_config >>
    executor:
      name: reporter
      selected_resource_class: << parameters.selected_resource_class >>
    steps:
      - checkout
      - run:
          name: "Reporting to packtracker.io"
          command: /entrypoint.sh

examples:
  simple:
    description: Simplest use case, leveraging default webpack config location and root project path.
    usage:
      version: 2.1
      orbs:
        packtracker: packtracker/report@x.y.z
      workflows:
        packtracker:
          jobs:
            - packtracker/report
  custom_webpack_config_path:
    description: Custom webpack config location (for example Ruby on Rails).
    usage:
      version: 2.1
      orbs:
        packtracker: packtracker/report@x.y.z
      workflows:
        packtracker:
          jobs:
            - packtracker/report:
                webpack_config: "./config/webpack/production.js"
  custom_nested_config_path:
    description: Custom project path, useful for monorepo situations.
    usage:
      version: 2.1
      orbs:
        packtracker: packtracker/report@x.y.z
      workflows:
        packtracker:
          jobs:
            - packtracker/report:
                project_root: "./packages/internal_package"
  custom_resource_class:
    description: Custom resource class if your build is running out of memory.
    usage:
      version: 2.1
      orbs:
        packtracker: packtracker/report@x.y.z
      workflows:
        packtracker:
          jobs:
            - packtracker/report:
                selected_resource_class: medium+
  exclude_some_assets_from_reporting:
    description: Excluding specific assets with `main` or `pack` in their name.
    usage:
      version: 2.1
      orbs:
        packtracker: packtracker/report@x.y.z
      workflows:
        packtracker:
          jobs:
            - packtracker/report:
                exclude_assets: "main|pack"