RelativeCI uses the agent to collect, validate, filter, and send webpack stats and build information to the service API.

The API analyzes the webpack stats using bundle-stats, saves the result, and triggers the project specific integrations(GitHub check status report, GitHub pull request comment, Slack notification).

The application allows users to view project metric trends or the in-depth job reports.

The base branch is the project default branch and is used to get the baseline for a new job. When a project is created, the base branch is populated from your GitHub repository default branch, but you can change it to match your workflow on Project -> Settings page.

The baseline job is the latest job in the base branch at the moment when the new job is created. The job baseline metrics are used to compare and to generate any of the metrics & insights that are depending on baseline values (eg: Cache invalidation).

RelativeCI does not have access to the repository source code. The GitHub application installation will ask for the following permissions:

• Metadata - list collaborators and repository metadata
• Commit Statuses - add commit status
• Checks - add commit status checks and reports
• Pull requests - add pull request comments

The agent validates, filters the webpack stats, and sends only the necessary data (eg: asset/module name and size). Also, the agent relies on env-ci to read information about the current build job. We do not access, process, or send any source code.

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, build, buildUrl, commit, isCi, pr, prBranch, service, slug.

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, feel free to get in touch.

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

copy
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:

copy
RELATIVE_CI=true npm run build

A job is a successful processed request sent by the agent for one of your projects. We count all the jobs across all the organization's projects.

The job stats size is the size of the data filtered and uploaded by relative-ci/agent and processed by RelativeCI. You can view the job stats on the job info section or by enabling DEBUG mode on the agent (check debug instructions based on your agent installation type). Also, you can view the daily stats usage for the entire organization on Organization -> Settings -> Usage page.

As an example, the job stats size for an application with 100 assets and 1500 module is approximately 250KB.

You will receive notifications when your usage quota for the current billing period will reach 90% and 100% of the limit. If your organization quota will exceed any of the limits, RelativeCI will stop processing job requests. To avoid not processed jobs, you can consider upgrading to a larger plan or configure your CI service to skip running the agent for every commit.

The Open Source subscriptions are set up initially with fair usage monthly limits(500 jobs, 250MiB stats). However, if you get notified of reaching your monthly quota, don't hesitate to contact us, and we will happily increase the limits.

RelativeCI uses Paddle.com to manage subscriptions. We support all major card providers and PayPal.

Depending on your region or entity type (consumer/organization), Paddle will collect the applicable tax. The total price will be calculated at the payment step.

You can cancel your organization subscription any time.

You can ask for a refund within 14 days from your latest payment.