The agent validates, filters the bundle stats, and sends only the necessary data (eg: asset/module name and size, chunk information). For the build information, the agent relies on env-ci to read information about the current build job.

Read more about the build information collected by the agent

To inspect the agent payload, you can use payloadFilepath option to save the data on disk:

• How to inspect payload on @relative-ci/agent webpack-plugin
• How to inspect payload on @relative-ci/agent CLI
• How to inspect payload on @relative-ci/agent-action

@relative-ci/agent expects the presence of specific environment variables to identify the project and label individual jobs:

• RELATIVE_CI_KEY: the RelativeCI API key specific for your project
• Continuous Integration(CI) environment variables: RelativeCI uses env-ci to normalize the variables across different CI services. The agent uses the following properties: branch, baseBranch, build, buildUrl, commit, isCi, pr, prBranch, service, slug
• Optional data: commitMessage.

RelativeCI uses env-ci to get the build information for each build. env-ci supports all major CI services: AppVeyor, Azure Pipelines, Bamboo, Bitbucket, Bitrise, Buddy, Buildkite, CircleCI, Cirrus CI, Cloudflare Pages, AWS CodeBuild, Codefresh, Codeship, Drone, GitHub Actions, GitLab CI/CD, Jenkins, Netlify, Puppet, Sail CI, Screwdriver.cd, Scrutinizer, Semaphore, Shippable, TeamCity, Travis CI, Vela, Vercel, Wercker, JetBrains Space, Woodpecker CI.

If your CI service is missing from the list or if you encounter any issues with your setup, please get in touch.

If you run multiple build tasks for every commit, it is recommended to configure @relative-ci/agent to run only once during a build task. To achieve this, you can enable the plugin based on a specific environment variable:

const { RelativeCiAgentWebpackPlugin } = require('@relative-ci/agent');

module.exports = {
  // ... your webpack config
  plugins: [
    // ... other plugins
    new RelativeCiAgentWebpackPlugin({
      enabled: process.env.RELATIVE_CI
    })
  ]
};

Run the build task with the environment variable:

RELATIVE_CI=true npm run build