Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚧Improve logging #44

Closed
4 of 6 tasks
CalvinWilkinson opened this issue Aug 29, 2024 · 0 comments · Fixed by #47
Closed
4 of 6 tasks

🚧Improve logging #44

CalvinWilkinson opened this issue Aug 29, 2024 · 0 comments · Fixed by #47
Assignees
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

Comments

@CalvinWilkinson
Copy link
Member

CalvinWilkinson commented Aug 29, 2024

Complete The Item Below

  • I have updated the title without removing the 🚧 emoji.

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 is package.version, but the file that contains the version does not contain a json key with the name package, 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:

  • Unit tests might pass locally but not in the CI environment during the status check process or vice-versa.
  • Tests might pass on the developer's machine but not necessarily on the code reviewer's machine.
  • If you notice that the test status check has passed but the test failed locally, please notify a project maintainer!

💡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

Change Type Label
Bug Fixes 🐛bug
Breaking Changes 🧨breaking-changes
New Feature ✨new-feature
CICD Changes ♻️cicd
Config Changes ⚙️config
Performance Improvements 🏎️performance
Code Doc Changes 🗒️documentation/code
Product Doc Changes 📝documentation/product

Priority Type Labels

Priority Type Label
Low Priority low priority
Medium Priority medium priority
High Priority high priority

Code of Conduct

  • I agree to follow this project's Code of Conduct.
@CalvinWilkinson CalvinWilkinson added preview Done while in preview 🐛bug Something isn't working labels Aug 29, 2024
@CalvinWilkinson CalvinWilkinson added this to the v1.0.0-preview.5 milestone Aug 29, 2024
@CalvinWilkinson CalvinWilkinson self-assigned this Aug 29, 2024
@CalvinWilkinson CalvinWilkinson changed the title 🚧Improve logging in release prepper 🚧Improve logging Aug 29, 2024
CalvinWilkinson added a commit that referenced this issue Aug 29, 2024
@CalvinWilkinson CalvinWilkinson added area:release-prep Changes related to preparing a release 💎enhancement An improvement on something ♻️cicd CI/CD related work only labels Aug 29, 2024
CalvinWilkinson added a commit that referenced this issue Aug 29, 2024
* Start work for issue #44

* fix: fix logging issue in the release prepper class

* enhance: update log message with additional information

* ci: fix if logic in sync workflow
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant