vaticle-bot
commented
3 months 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
- [ ] This change is trivial and does not require a code or architecture review.
Code
- [x] Packages, classes, and methods have a single domain of responsibility.
- [x] Packages, classes, and methods are grouped into cohesive and consistent domain model.
- [x] The code is canonical and the minimum required to achieve the goal.
- [x] Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
- [x] Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
- [x] The code is algorithmically efficient and scalable for the whole application.
Architecture
- [x] Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
- [x] Any required build and release automations are updated and/or implemented.
- [x] Any new components follows a consistent style with respect to the pre-existing codebase.
- [x] The architecture intuitively reflects the application domain, and is easy to understand.
- [x] The architecture has a well-defined hierarchy of encapsulated components.
- [x] The architecture is extensible and scalable.
What is the goal of this PR?
Our version bump tool now supports two types of file - text and package.json. This tool will bump the relevant version of the file and write it to disk.
What are the changes implemented in this PR?
We've added support for text and package.json. We've removed the git commit and push functionality.
Notes
Since no one is using this tool, we have not reintroduced the commit and push functionality elsewhere, but doing so should be trivial. We found that having the incrementing, writing, committing and pushing happening within a single tool was too much complexity in a single tool and ended up hampering flexibility of use. We found we wanted to bump multiple files using this single tool but not produce multiple commits (and multiple pushes).