Skip to content

Commit fa56eef

Browse files
committed
Delete unnecessary filename/frontmatter validation instructions
1 parent 13b1321 commit fa56eef

1 file changed

Lines changed: 2 additions & 25 deletions

File tree

‎unreleased-change-notes/README.md‎

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,13 @@
1-
## Change notes
1+
## Change notes
22

3-
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`.
3+
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`.
44

55
### Change-note file format
66

77
Change-note files must follow a certain format so that they can be automatically validated and processed. Failure to follow the format will result in a failed PR check.
88

99
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.
1010

11-
#### File name
12-
13-
Change-note files must be named according to the following pattern: `YYYY-MM-DD-<short-title>.md`, where `YYYY-MM-DD` is the date of the change and `<short-title>` is a short description of the change. The `<short-title>` 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`.
14-
15-
#### Frontmatter
16-
17-
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:
18-
19-
| Category | Description |
20-
| -------- | ----------- |
21-
| `breaking` | A change that introduces backward-incompatible behavior. |
22-
| `feature` | A new capability or behavior added to the Action. |
23-
| `improvement` | An enhancement to existing functionality or performance. |
24-
| `securityFix` | A change that addresses a security vulnerability. |
25-
| `fix` | A bug fix that corrects unexpected behavior. |
26-
| `unship` | Features or options that have been removed. |
27-
| `deprecation` | Deprecation of features that will be removed in future versions. |
28-
| `knownIssue` | A known issue or limitation in the current release. |
29-
| `misc` | Other changes that do not fit into other categories. |
3011

3112
#### Body
3213

@@ -38,10 +19,6 @@ The body of the change-note file must:
3819
### Example change-note file
3920

4021
```
41-
---
42-
category: fix
43-
---
44-
4522
- 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)
4623
- 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)
4724
```

0 commit comments

Comments
 (0)