Add script and VSCode task for creating change notes #18086
+103
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a VSCode Task (accessible from the "Run Task" menu) for creating change notes, prompting the user for the language, name, and category of the change. The language options presented are based on the existing occurrences of `change-notes` folders in the repo. There are more such files (in particular every shared library has a `change-notes` directory), but it seemed to me that the language change notes are the ones that are most common, and so in an effort to not clutter the list too much, I only included the languages. The selection of categories is based on existing usage -- more specifically the result of grepping for occurrences of '^category: ' in the repo. It's possible there are more change categories that could be added. Hopefully this should make it more convenient to create change notes from within VSCode.
There was a problem hiding this comment.
Copilot reviewed 1 out of 2 changed files in this pull request and generated no suggestions.
Files not reviewed (1)
- .vscode/tasks.json: Language not supported
Comments skipped due to low confidence (1)
misc/scripts/create-change-note.py:31
- The error message could be more informative. Consider changing it to: 'Output directory {language}/ql/lib/change-notes does not exist. Please ensure the directory path is correct.'
print(f"Output directory {language}/ql/lib/change-notes does not exist")
Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more
aeisenberg
approved these changes
Nov 22, 2024
jketema
requested changes
Nov 22, 2024
Comment on lines
+87
to
+91
| "minorAnalysis", | ||
| "newQuery", | ||
| "fix", | ||
| "majorAnalysis", | ||
| "breaking", |
There was a problem hiding this comment.
Note that the categories differ between library changes and query changes: https://github.com/github/codeql/blob/main/docs/change-notes.md
| # - The name of the change note (in kebab-case) | ||
| # - The category of the change. | ||
|
|
||
| # The change note will be created in the `{language}/ql/lib/change-notes` directory. |
There was a problem hiding this comment.
What about query changes? Which should go in {language}/ql/src/change-notes?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a VSCode Task (accessible from the "Run Task" menu) for creating change notes, prompting the user for the language, name, and category of the change.
The language options presented are based on the existing occurrences of
change-notesfolders in the repo. There are more such files (in particular every shared library has achange-notesdirectory), but it seemed to me that the language change notes are the ones that are most common, and so in an effort to not clutter the list too much, I only included the languages.The selection of categories is based on existing usage -- more specifically the result of grepping for occurrences of
'^category: 'in the repo. It's possible there are more change categories that could be added.Hopefully this should make it more convenient to create change notes from within VSCode.
Pull Request checklist
All query authors
.qhelp. See the documentation in this repository.Internal query authors only
.ql,.qll, or.qhelpfiles. See the documentation (internal access required).