Skip to content

Commit 744d139

Browse files
author
Dave Bartolomeo
authored
Add more examples
1 parent 97193f7 commit 744d139

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

Adding change notes.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Each CodeQL query pack or library pack has its own change log to track how that pack changes with each release. Any non-trivial, user-visible change to a query or library should add a change note to the affected pack. This document describes how to do that.
44

55
## Creating a change note
6-
To create a new change note for a pack, create a new markdown file in the `change-notes` directory of the pack (e.g., in `cpp/ql/src/change-notes` for the C++ standard query pack). The markdown file must be named `YYYY-MM-DD-id.md`, where `YYYY-MM-DD` is the date of the change, and `id` is a short string to help identify the change. For example, if you were adding a new integer overflow query to the C++ standard query pack, you might do so from a branch named `int-overflow-query`, with a change note file named `cpp/ql/src/change-notes/2021-12-14-int-overflow-query.md`. Here is an example change note file:
6+
To create a new change note for a pack, create a new markdown file in the `change-notes` directory of the pack (e.g., in `cpp/ql/src/change-notes` for the C++ standard query pack). The markdown file must be named `YYYY-MM-DD-id.md`, where `YYYY-MM-DD` is the date of the change, and `id` is a short string to help identify the change. For example, if you were adding a new integer overflow query to the C++ standard query pack, you might do so from a branch named `int-overflow-query`, with a change note file named `cpp/ql/src/change-notes/2021-12-14-int-overflow-query.md`. Here are a few example change note files:
77

88
```yaml
99
---
@@ -12,6 +12,27 @@ category: newQuery
1212
* Added a new query, `cpp/integer-overflow`, to detect code that depends on the result of signed integer overflow.
1313
```
1414

15+
```yaml
16+
---
17+
category: fix
18+
---
19+
* Fixed a performance issue where the `cpp/integer-overflow` query would time out on large databases.
20+
```
21+
22+
```yaml
23+
---
24+
category: minorAnalysis
25+
---
26+
* Added taint flow model for `std::codecvt`.
27+
```
28+
29+
```yaml
30+
---
31+
category: majorAnalysis
32+
---
33+
* Added taint flow model for `std::string`.
34+
```
35+
1536
### Metadata
1637
The change note file requires some metadata at the beginning of the file. This metadata is later used to determine how to advance the version number of the pack next time it is published, and to group related change notes in the final changelog. The metadata is YAML, enclosed by a `---` line before and after.
1738

0 commit comments

Comments
 (0)