Skip to content

docs: explicitly require exactly one changelog type checkbox in copilot instructions#12

Merged
nilsandrey merged 3 commits intonilsandrey-release-patchfrom
copilot/sub-pr-10
Mar 9, 2026
Merged

docs: explicitly require exactly one changelog type checkbox in copilot instructions#12
nilsandrey merged 3 commits intonilsandrey-release-patchfrom
copilot/sub-pr-10

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 9, 2026

The copilot-instructions.md guidance on PR descriptions was silent on the "exactly one checkbox" constraint for the changelog type section, leaving contributors unaware that an unchecked type blocks the release workflow entirely.

Changes

  • .github/copilot-instructions.md: Replaced the vague "type of change must be accurately indicated" sentence with an explicit rule — exactly one of Major/Minor/Patch must be checked, the workflow picks the first matching box (Major → Minor → Patch), and leaving all unchecked prevents release creation.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…rn on empty

Co-authored-by: nilsandrey <3579285+nilsandrey@users.noreply.github.com>
Copilot AI changed the title [WIP] Update pull request description guidelines based on feedback docs: explicitly require exactly one changelog type checkbox in copilot instructions Mar 9, 2026
Clarify requirements for pull request descriptions regarding changelog and versioning.

Signed-off-by: Nils <nilsandrey@gmail.com>
@nilsandrey nilsandrey marked this pull request as ready for review March 9, 2026 15:53
Copilot AI review requested due to automatic review settings March 9, 2026 15:53
@nilsandrey nilsandrey merged commit c7f68ca into nilsandrey-release-patch Mar 9, 2026
1 check passed
@nilsandrey nilsandrey deleted the copilot/sub-pr-10 branch March 9, 2026 15:53
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates repository contribution guidance so PR authors understand the release workflow’s constraints around changelog type selection.

Changes:

  • Clarifies that the changelog markers are required and that a changelog type checkbox must be selected.
  • Adds explicit guidance about the checkbox selection rule and the workflow’s selection precedence (Major → Minor → Patch).


PR descriptions must contain the expected sections for the Release pipeline used to update the changelog and release notes. Follow the [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md) template and fill in the description and type of change (major, minor, patch). Note that the markup comment tags (`<!--changelog-description-start-->`, `<!--changelog-description-end-->`, `<!--changelog-type-start-->`, and `<!--changelog-type-end-->`) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes.

The type of change must be accurately indicated to ensure proper versioning. **Exactly one** of the Major/Minor/Patch checkboxes must be checked — the release workflow picks the first matching checked box (Major → Minor → Patch) and will fail to create a release if none are checked.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There’s an extra leading space before “The type of change…” which makes this paragraph misaligned with the surrounding text and can cause odd Markdown rendering in some contexts. Remove the leading whitespace so the paragraph starts flush-left like the others.

Suggested change
The type of change must be accurately indicated to ensure proper versioning. **Exactly one** of the Major/Minor/Patch checkboxes must be checked — the release workflow picks the first matching checked box (Major → Minor → Patch) and will fail to create a release if none are checked.
The type of change must be accurately indicated to ensure proper versioning. **Exactly one** of the Major/Minor/Patch checkboxes must be checked — the release workflow picks the first matching checked box (Major → Minor → Patch) and will fail to create a release if none are checked.

Copilot uses AI. Check for mistakes.

PR descriptions must contain the expected sections for the Release pipeline used to update the changelog and release notes. Follow the [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md) template and fill in the description and type of change (major, minor, patch). Note that the markup comment tags (`<!--changelog-description-start-->`, `<!--changelog-description-end-->`, `<!--changelog-type-start-->`, and `<!--changelog-type-end-->`) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes.

The type of change must be accurately indicated to ensure proper versioning. **Exactly one** of the Major/Minor/Patch checkboxes must be checked — the release workflow picks the first matching checked box (Major → Minor → Patch) and will fail to create a release if none are checked.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence says “Exactly one … must be checked” but the workflow logic actually selects the first matching checkbox (Major → Minor → Patch) and only hard-fails when none are checked. To keep the docs strictly accurate, consider wording this as a contributor requirement (“check exactly one”) while also noting what happens if multiple are checked (the workflow will choose the first match).

Suggested change
The type of change must be accurately indicated to ensure proper versioning. **Exactly one** of the Major/Minor/Patch checkboxes must be checked the release workflow picks the first matching checked box (Major → Minor → Patch) and will fail to create a release if none are checked.
The type of change must be accurately indicated to ensure proper versioning. Contributors must select **exactly one** of the Major/Minor/Patch checkboxes; if multiple are checked the release workflow will use the first matching checked box in priority order (Major → Minor → Patch) and will fail to create a release only if none are checked.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants