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

feat(cli): detect breaking change syntax #91

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Conversation

cdcabrera
Copy link
Owner

@cdcabrera cdcabrera commented Oct 7, 2023

What's included

  • feat(cli): detect breaking change syntax

Notes

  • the original intention of keeping changelog-light "light" included the ability to provide your own custom message. the intention being the maintainer could simply fill in the blanks on breaking changes... for us personally this became annoying to use, now the tool reads the accepted syntax for breaking change commit messages (plus a slight variation to account for future language formats), this includes
    • 'BREAKING CHANGE:', 'BREAKING CHANGES:' within the commit message body
    • and ')!:', '!:'to account for commit message subject lines
  • there is an aspect of "finding commits" that contain the breaking change syntax that could be deduped using a Set, however because of the way we're doing a find on the git hash this is unnecessary, currently, cmds.js line 195

How to test

Coverage and basic unit test check

  1. update the NPM packages with $ yarn
  2. $ yarn test
  3. confirm tests come back clean

Example

...

Updates issue/story

ongoing

@cdcabrera cdcabrera added the enhancement New feature or request label Oct 7, 2023
@codecov-commenter
Copy link

codecov-commenter commented Oct 7, 2023

Codecov Report

Merging #91 (25da297) into main (31a1a44) will increase coverage by 0.99%.
The diff coverage is 94.44%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #91      +/-   ##
==========================================
+ Coverage   92.14%   93.14%   +0.99%     
==========================================
  Files           5        5              
  Lines         242      277      +35     
  Branches       98      109      +11     
==========================================
+ Hits          223      258      +35     
  Misses         18       18              
  Partials        1        1              
Files Coverage Δ
src/index.js 86.66% <100.00%> (ø)
src/cmds.js 95.00% <96.42%> (+2.14%) ⬆️
src/files.js 89.79% <50.00%> (ø)
src/parse.js 96.80% <95.23%> (+0.42%) ⬆️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 31a1a44...25da297. Read the comment docs.

src/cmds.js Show resolved Hide resolved
@cdcabrera cdcabrera force-pushed the breaking-changes branch 3 times, most recently from a534a74 to 30f7ed8 Compare October 10, 2023 08:59
@cdcabrera cdcabrera merged commit 4e92f4e into main Oct 10, 2023
@cdcabrera cdcabrera deleted the breaking-changes branch October 10, 2023 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants