🚧Improve logging #44
Labels
area:release-prep
Changes related to preparing a release
🐛bug
Something isn't working
♻️cicd
CI/CD related work only
💎enhancement
An improvement on something
preview
Done while in preview
Milestone
Complete The Item Below
Description
Improve logging throughout the application
Improve logging in
release-prepper.ts
In the release prepper, there are various logs to the console that need improvement.
An example of the current log:
ConsoleLogColor.red("The assignee (github login) does not exist.");
This log has the text '(gitub login)' but it should be the name of the actual login name. This must of been filler text and was never finished.
So if the login was 'KinsonDigital', then the log message should be:
The assignee 'KinsonDigital' does not exist
Find all log messages like this in the release-prepper.ts file and update them.
Improve logging in
JsonVersionUpdater
class:Improve the log message when the version JSON key path cannot be found. For example, when the
versionJSONKeyPath
value in the prepare release settings json config file ispackage.version
, but the file that contains the version does not contain a json key with the namepackage
, an error will be logged into the console like shown below:The property 'package' does not exist.
This is not informative. Update the message to show the name or path to the file that is missing the key value.
Acceptance Criteria
The items to complete to satisfy the Definition of Done.
ToDo Items
The items to complete to satisfy the Definition of Done.
Issue Dependencies
No response
Related Work
No response
Additional Information:
Unit Tests
Reasons for local unit test execution:
💡Warning💡
If the unit tests pass remotely and are not executed locally, this means we could be letting a bug slip into production.
Though bugs will always exist in some capacity, we should all do our part to help prevent them from happening.
Change Type Labels
🐛bug
🧨breaking-changes
✨new-feature
♻️cicd
⚙️config
🏎️performance
🗒️documentation/code
📝documentation/product
Priority Type Labels
low priority
medium priority
high priority
Code of Conduct
The text was updated successfully, but these errors were encountered: