Skip to content

About this page

On this page

CI checks ​

The ci.ci workflow (ci.yml) is the repository's main check. It runs on pushes to ci.changelog.branches.main and on pull requests to the generated branch globs, and its default job:

  1. checks out the repo, sets up Node and Corepack, and installs dependencies;
  2. runs commitlint over the pushed range — removed when commitlint is disabled with ci.changelog.commitlint: false;
  3. runs dbx sync --check so generated files cannot drift;
  4. runs the package manager's build.
dbx.config.ts
ts
toolchain: {
    ci: {
        ci: {
            pullRequestBranches: ['main', 'dev', 'release/**', 'dependabot/**'],
            steps: {
                after: [
                    { name: 'Format + lint', run: 'yarn check:fix' },
                    { name: 'Test', run: 'yarn test' },
                ],
            },
        },
    },
}

Use Workflow settings for the shared options. The workflow is opt-in: ci: { ci: true } writes it; omitting ci.ci (or setting it to false) leaves the file unmanaged. Set provider (gitlab/azure) with a complete workflow object to write that vendor's pipeline instead.