vaticle-bot
commented
1 year ago PR Review Checklist
Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.
Trivial Change
- [x] This change is trivial and does not require a code or architecture review.
Code
- [ ] Packages, classes, and methods have a single domain of responsibility.
- [ ] Packages, classes, and methods are grouped into cohesive and consistent domain model.
- [ ] The code is canonical and the minimum required to achieve the goal.
- [ ] Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
- [ ] Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
- [ ] The code is algorithmically efficient and scalable for the whole application.
Architecture
- [ ] Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
- [ ] Any required build and release automations are updated and/or implemented.
- [ ] Any new components follows a consistent style with respect to the pre-existing codebase.
- [ ] The architecture intuitively reflects the application domain, and is easy to understand.
- [ ] The architecture has a well-defined hierarchy of encapsulated components.
- [ ] The architecture is extensible and scalable.
What is the goal of this PR?
We integrate the new release notes tooling. The release notes are now to be written by a person and committed to the repo.
What are the changes implemented in this PR?
tools/release/create_notes.shis a manual replacement for automatic@vaticle_dependencies//tool/release/notes:createin CI. The script is meant to be executed manually by the writer of the release notes, who will edit the autocompiled notes before committing RELEASE_NOTES_LATEST.md to the repository.In the Release job in Factory, we validate that the release notes have been updated since the last tagged release (last by semantic version).