This page contains the setup guide for the RelativeCI agent v5 beta. Go to RelativeCI agent v4 to read the setup guide for the current stable version.
Step 1. Install
npm install --save-dev @relative-ci/cli@v5.0.0-rc.1
yarn add --dev @relative-ci/cli@v5.0.0-rc.1
pnpm add -D @relative-ci/cli@v5.0.0-rc.1
Step 2. Output webpack stats JSON file
Follow the steps on Output webpack stats JSON file guide.
Step 3. Configure @relative-ci/cli
relativeci.config.js
module.exports = { // Get current commit message (`git show -s --format=%B`) // and send it to RelativeCI as part of the build information 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
Your project RelativeCI API key. To view the corresponding key for your project, navigate to https://app.relative-ci.com and go to the project Settings -> API Keys page.
More resources:
Run agent CLI on CI
Add a CI job to run @relative-ci/cli
after the build job.
View config examples for:
Monorepo
If you are using a monorepo setup and need to send the build information and the stats for multiple projects, use different API keys and stat files for each project.
.github/workflow/build.yml
# ...
- name: Project A - build run: cd project-a && npm run build --json webpack-stats.json
- name: Project A - send build information and bundle stats to RelativeCI run: cd project-a && npx relative-ci env: RELATIVE_CI_KEY: ${{ secrets.RELATIVE_CI_KEY_PROJECT_A }}
- name: Project B - build run: cd project-b && npm run build --json webpack-stats.json
- name: Project B - send build information and bundle stats to RelativeCI run: cd project-b && npx relative-ci env: RELATIVE_CI_KEY: ${{ secrets.RELATIVE_CI_KEY_PROJECT_B }}