Skip to content

Conversation

dbartol
Copy link

@dbartol dbartol commented Dec 14, 2021

This PR has two separate commits.

  • The first commit moves all change notes added since the last dist upgrade into the affected pack's change-notes directory, where the automatic changelog generation will pick them up.
  • The second commit renames the change-notes directory at the language level (e.g., cpp/change-notes) to old-change-notes to reduce the temptation to add new change notes there. I'm working separately on a document to describe how to add change notes for a pack.

Dave Bartolomeo added 2 commits December 14, 2021 12:05
Now that change notes are per-package, new change notes should be created in the `change-notes` folder under the affected pack (e.g., `cpp/ql/src/change-notes` for C++ query change notes. I've moved all of the change note files that were added before we started publishing them in packs to an `old-change-notes` directory under each language, to reduce the temptation to add new change notes there.

I'm working on a document to describe how and when to create change notes for packs separately.
Copy link
Contributor

@aeisenberg aeisenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks good to me.

@aeisenberg
Copy link
Contributor

Are there any prepare release workflow changes that need to happen as well?

@dbartol
Copy link
Author

dbartol commented Dec 14, 2021

Are there any prepare release workflow changes that need to happen as well?

Nope. This just moves everything so that the existing release prep workflow will work, and so that people won't keep adding new change notes in the wrong place. I did the same thing for the previous release, except for the renaming the old directory part.

@dbartol
Copy link
Author

dbartol commented Dec 14, 2021

See #7400 for the new instructions on creating change notes.

@dbartol dbartol merged commit 6664a38 into codeql-cli-2.7.4 Dec 14, 2021
@dbartol dbartol deleted the dbartol/fix-change-notes branch December 14, 2021 18:53
@aschackmull
Copy link
Contributor

Looks like java/change-notes/2021-11-15-overrides.md was accidentally deleted?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants