Jun 16, 2025 · Jun 8, 2025 · Jun 8, 2025 · Jun 9, 2025 · Jun 9, 2025 · Jun 9, 2025
diff --git a/.github/actions/breaking-pr-check/action.yml b/.github/actions/breaking-pr-check/action.yml
 description: Validate breaking change PR title and description

 runs:
  using: node20
  main: index.js
  using: 'composite'
  steps:
    - name: Check PR title and body using github-script
      uses: actions/github-script@v7
      with:
        github-token: ${{ env.GITHUB_TOKEN }}
        script: |
          async function getPullRequest() {
            const pr = context.payload.pull_request;
            if (!pr) {
              throw new Error("This action can only be run on pull_request events.");
            }

            const owner = pr.base.repo.owner.login;
            const repo = pr.base.repo.name;
            const pull_number = pr.number;

            const { data } = await github.rest.pulls.get({
              owner,
              repo,
              pull_number,
            });

            return data;
          }

          function checkTitle(title) {
            if (/^[a-z]+(\([a-z-]+\))?!: /.test(title)) {
              throw new Error(
                `Do not use exclamation mark ('!') to indicate breaking change in the PR Title.`,
              );
            }
          }

          function checkDescription(body, labels) {
            if (!labels.some(label => label.name === 'breaking change')) {
              return;
            }

            const [firstLine, secondLine] = body.split(/\r?\n/);

            if (!firstLine || !/^BREAKING CHANGE:/.test(firstLine)) {
              throw new Error(
                `Breaking change PR body should start with "BREAKING CHANGE:". See https://typescript-eslint.io/maintenance/releases#2-merging-breaking-changes.`,
              );
            }

            if (!secondLine) {
              throw new Error(
                `The description of breaking change is missing. See https://typescript-eslint.io/maintenance/releases#2-merging-breaking-changes.`,
              );
            }
          }

          const pr = await getPullRequest();
          checkTitle(pr.title);
          checkDescription(pr.body ?? '', pr.labels);
diff --git a/.github/actions/breaking-pr-check/index.js b/.github/actions/breaking-pr-check/index.js
diff --git a/...workflows/semantic-breaking-change-pr.yml → ...lows/semantic-breaking-change-pr-test.yml b/...workflows/semantic-breaking-change-pr.yml → ...lows/semantic-breaking-change-pr-test.yml
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/prepare-install
      - uses: ./.github/actions/breaking-pr-check
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/package.json b/package.json
    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
  },
  "devDependencies": {
    "@actions/core": "^1.10.1",
    "@actions/github": "^6.0.0",
    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
    "@eslint/compat": "^1.2.4",
    "@eslint/eslintrc": "^3.2.0",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,5 +2,60 @@ name: Validate Breaking Change PR
		description: Validate breaking change PR title and description

		runs:
		using: node20
		main: index.js
		using: 'composite'
		steps:
		- name: Check PR title and body using github-script
		uses: actions/github-script@v7
		with:
		github-token: ${{ env.GITHUB_TOKEN }}
		script: \|
		async function getPullRequest() {
		const pr = context.payload.pull_request;
		if (!pr) {
		throw new Error("This action can only be run on pull_request events.");
		}

		const owner = pr.base.repo.owner.login;
		const repo = pr.base.repo.name;
		const pull_number = pr.number;

		const { data } = await github.rest.pulls.get({
		owner,
		repo,
		pull_number,
		});

		return data;
		}

		function checkTitle(title) {
		if (/^[a-z]+(\([a-z-]+\))?!: /.test(title)) {
		throw new Error(
		`Do not use exclamation mark ('!') to indicate breaking change in the PR Title.`,
		);
		}
		}

		function checkDescription(body, labels) {
		if (!labels.some(label => label.name === 'breaking change')) {
		return;
		}

		const [firstLine, secondLine] = body.split(/\r?\n/);

		if (!firstLine \|\| !/^BREAKING CHANGE:/.test(firstLine)) {
		throw new Error(
		`Breaking change PR body should start with "BREAKING CHANGE:". See https://typescript-eslint.io/maintenance/releases#2-merging-breaking-changes.`,
		);
		}

		if (!secondLine) {
		throw new Error(
		`The description of breaking change is missing. See https://typescript-eslint.io/maintenance/releases#2-merging-breaking-changes.`,
		);
		}
		}

		const pr = await getPullRequest();
		checkTitle(pr.title);
		checkDescription(pr.body ?? '', pr.labels);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,7 +15,6 @@ jobs:
		runs-on: ubuntu-latest
		steps:
		- uses: actions/checkout@v4
		- uses: ./.github/actions/prepare-install
		- uses: ./.github/actions/breaking-pr-check
		env:
		GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -51,8 +51,6 @@
		"node": "^18.18.0 \|\| ^20.9.0 \|\| >=21.1.0"
		},
		"devDependencies": {
		"@actions/core": "^1.10.1",
		"@actions/github": "^6.0.0",
		"@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
		"@eslint/compat": "^1.2.4",
		"@eslint/eslintrc": "^3.2.0",
Expand Down