Skip to content

Commit c7f68ca

Browse files
Copilotnilsandrey
andauthored
docs: explicitly require exactly one changelog type checkbox in copilot instructions (#12)
--------- Signed-off-by: Nils <nilsandrey@gmail.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nilsandrey <3579285+nilsandrey@users.noreply.github.com> Co-authored-by: Nils <nilsandrey@gmail.com>
1 parent 23b4a54 commit c7f68ca

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

.github/copilot-instructions.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,10 @@ Commands that need user input use `InputModal` or `TwoInputModal` (in `src/modal
5353
- **Pull request descriptions must use the required changelog markup**: PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. See the following "Pull request description content" section.
5454

5555
### Pull request description content
56-
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.
56+
57+
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.
58+
59+
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.
5760

5861
Sample:
5962

0 commit comments

Comments
 (0)