From fa56eef12fd72da6f01e786304612ce03ba93a48 Mon Sep 17 00:00:00 2001 From: Mario Campos Date: Fri, 9 Oct 2026 16:48:00 -0500 Subject: [PATCH] Delete unnecessary filename/frontmatter validation instructions --- unreleased-change-notes/README.md | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) diff --git a/unreleased-change-notes/README.md b/unreleased-change-notes/README.md index d477a0b1b..60778c795 100644 --- a/unreleased-change-notes/README.md +++ b/unreleased-change-notes/README.md @@ -1,6 +1,6 @@ -## Change notes +## Change notes -Change-notes are Markdown files used to document user-facing changes. When making a change that affects users, create a markdown file here that describes the change. During the next release, the change-note files in `unreleased-change-notes/` will automatically be added to `CHANGELOG.md`. +Change-notes are Markdown files used to document user-facing changes. When making a change that affects users, create a Markdown file here that describes the change. During the next release, the change-note files in `unreleased-change-notes/` will automatically be added to `CHANGELOG.md`. ### Change-note file format @@ -8,25 +8,6 @@ Change-note files must follow a certain format so that they can be automatically You may validate your change-note file locally by running `npx tsx pr-checks/changenotes.ts validate`. This command will scan all change-note files in `unreleased-change-notes/` and report any errors. -#### File name - -Change-note files must be named according to the following pattern: `YYYY-MM-DD-.md`, where `YYYY-MM-DD` is the date of the change and `` is a short description of the change. The `` must contain only lowercase letters (`a-z`), digits (`0-9`), and hyphens (`-`), and must start with a letter or digit. Hyphens may be used to separate words. For example, a change-note file for a JSON-related bug fix that was made on January 1st, 2020 might be named `2020-01-01-fix-json-bug.md`. - -#### Frontmatter - -The first line of the file must be a YAML frontmatter block, which is delimited by lines containing three dashes (`---`). The frontmatter block must contain a single `category` field, whose value must be one of the following categories: - -| Category | Description | -| -------- | ----------- | -| `breaking` | A change that introduces backward-incompatible behavior. | -| `feature` | A new capability or behavior added to the Action. | -| `improvement` | An enhancement to existing functionality or performance. | -| `securityFix` | A change that addresses a security vulnerability. | -| `fix` | A bug fix that corrects unexpected behavior. | -| `unship` | Features or options that have been removed. | -| `deprecation` | Deprecation of features that will be removed in future versions. | -| `knownIssue` | A known issue or limitation in the current release. | -| `misc` | Other changes that do not fit into other categories. | #### Body @@ -38,10 +19,6 @@ The body of the change-note file must: ### Example change-note file ``` ---- -category: fix ---- - - Fixed a bug where a network error while streaming the download of the CodeQL bundle could terminate the `init` Action instead of falling back to downloading the bundle before extracting it. [#4061](https://github.com/github/codeql-action/pull/4061) - Fix incorrect minimum required Git version for [improved incremental analysis](https://github.com/github/roadmap/issues/1158): it should have been 2.36.0, not 2.11.0. [#3781](https://github.com/github/codeql-action/pull/3781) ```