Skip to main content

require-release-config-file

Require repository-local release tooling or release metadata configuration.

Targeted pattern scope​

This rule checks for the presence of one of the following recognised release tooling or release metadata configuration files:

  • GitHub release metadata: .github/release.yml, .github/release.yaml, .github/release-drafter.yml, .github/release-drafter.yaml, .github/workflows/release.yml, .github/workflows/release.yaml, .github/workflows/release-drafter.yml, .github/workflows/release-drafter.yaml
  • Release Please / Changesets: release-please-config.json, .release-please-manifest.json, .release-please-config.json, .release-please-config.yaml, .release-please-config.yml, .release-please-config.json5, .changeset/config.json, .changeset/config.yaml, .changeset/config.yml, .changeset/config.js, .changeset/config.cjs, .changeset/config.mjs
  • semantic-release / release-it: .releaserc, .releaserc.json, .releaserc.js, .releaserc.cjs, .releaserc.mjs, .releaserc.yml, .releaserc.yaml, .releaserc.ts, .release-it.json, .release-it.js, .release-it.cjs, .release-it.mjs, .release-it.yml, .release-it.yaml, .release-it.ts, release.config.js, release.config.cjs, release.config.mjs, release.config.ts, release.config.json, release.config.yaml, release.config.yml, release-it.config.js, release-it.config.cjs, release-it.config.mjs, release-it.config.ts, release-it.config.json, release-it.config.yaml, release-it.config.yml
  • git-cliff and generic release metadata: cliff.toml, .cliff.toml, cliff.yaml, cliff.yml, .cliff.yaml, .cliff.yml, .release.json, .release.yaml, .release.yml, .release.js, .release.cjs, .release.mjs

What this rule reports​

This rule reports when none of the recognised release tooling or release metadata configuration files is found.

Why this rule exists​

Repository-local release tooling and release metadata make release behavior more discoverable and easier to review. This rule does not prove that releases are correctly automated or that semantic versioning is enforced; it only ensures the repository contains a supported release-related configuration surface instead of leaving release behavior implicit.

❌ Incorrect​

// No release tooling or release metadata configuration found
.github/
  workflows/
    ci.yml
src/
package.json

✅ Correct​

// release-please-config.json
{
  "$schema": "https://docs.renovatebot.com/release-please-config.json",
  "packages": {
    ".": {
      "release-type": "node"
    }
  }
}

ESLint flat config example​

import repoPlugin from "eslint-plugin-repo";

export default [
  repoPlugin.configs.github,
  {
    plugins: { "repo-compliance": repoPlugin },
    rules: {
      "repo-compliance/require-release-config-file": "warn",
    },
  },
];

When not to use it​

Disable this rule if your project uses a different release tool not listed above, or if releases are managed entirely outside this repository and no repository-local release configuration is expected.

Rule catalog ID: R044

Further reading​