Setup @relative-ci/agent CLI

Step 1. Install

npm install --save-dev @relative-ci/agent
yarn add --dev @relative-ci/agent
pnpm add -D @relative-ci/agent

Step 2. Output webpack stats JSON file

Follow the steps on Output webpack stats JSON file guide.

Step 3. Configure @relative-ci/agent

relativeci.config.js
module.exports = {
// Allow the agent to pick up the current commit message
includeCommitMessage: true,
// Save agent payload to disk for debugging
// @example './relative-ci-payload.json',
payloadFilepath: undefined,
webpack: {
// Path to Webpack stats JSON file
stats: './webpack-stats.json'
}
};

Step 4. Configure Continuous integration(CI) service

Add environment variables

RELATIVE_CI_KEY

(Required) Navigate to https://app.relative-ci.com and copy the project specific key from Project -> Settings -> Keys.

RELATIVE_CI_SLUG

(Required for unsupported CI services) Set your GitHub project slug (eg: webpack/webpack.js.org) if your CI service is not supported (https://github.com/semantic-release/env-ci#supported-ci).

RELATIVE_CI_ENDPOINT

(Required for Enterprise Cloud customers)

Run agent CLI on CI

Add a CI job to run @relative-ci/agent after the build job.

View config examples for:





Need help?Contact us via email, Twitter, or GitHub!