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

Auto categorize CLI flag #212

Merged
merged 23 commits into from
Jan 27, 2025
Merged

Auto categorize CLI flag #212

merged 23 commits into from
Jan 27, 2025

Conversation

jake-perkins
Copy link
Contributor

@jake-perkins jake-perkins commented Jan 21, 2025

This adds a new --autoCategorize flag to the CLI which will categorize the conventional commits to keep a changelog format for the generated changelog

Example output runs

yarn auto-changelog update --autoCategorize


Uncategorized

  • tweaking configs
  • newline
  • update changelog
  • remove logs
  • testing
  • reset changelog
  • readme
  • format changelog

Added

  • feat: testing conv commit feat
  • feat: categorize conventional commits

Fixed

  • fix: format
  • fix: testing conv commit

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@jake-perkins jake-perkins requested a review from a team as a code owner January 21, 2025 15:46

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@jake-perkins jake-perkins changed the title Auto categorize Auto categorize CLI flag Jan 21, 2025
sethkfman
sethkfman previously approved these changes Jan 21, 2025
Copy link

@sethkfman sethkfman left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

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

This makes sense to me, I just had some suggestions.

It doesn't appear that we have any tests for updateChangelog. However, would you mind adding some in an update-changelog.test.ts file for your new changes? It doesn't have to test any of the existing functionality, just your addition.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
jake-perkins and others added 2 commits January 23, 2025 08:50
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
@mcmire
Copy link
Contributor

mcmire commented Jan 23, 2025

Looks like there are some lint failures to fix, and then I can approve.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@jake-perkins
Copy link
Contributor Author

@mcmire @cryptodev-2s would you mind re-reviewing/approving ?
For the reasons outlined in this https://stackoverflow.com/questions/51269431/jest-mock-inner-function
at the request to add unit tests for the update flow I had to move some of the read interactions to a seperate module to allow the inner mocking to get the desired testing coverage of use-cases. Let me know of any questions/concerns!

Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of this! LGTM.

@jake-perkins jake-perkins merged commit 4136117 into main Jan 27, 2025
15 checks passed
@jake-perkins jake-perkins deleted the auto-categorize branch January 27, 2025 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants