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

fix: always include breaking changes in changelog #96

Merged
merged 6 commits into from
Jul 12, 2022

Conversation

bastidest
Copy link
Contributor

Closes #95

@qoomon
Copy link
Owner

qoomon commented Jul 12, 2022

Hi @bastidest, thanks for this PR. I totally agree on the functionality, however I'd like to have a slightly different implementations. I would prefer to move the whole filter logic into lib/changelogGenerator.js and pass filter option to changelogGenerator.generateMarkdown() instead of marking changelog commits. WDYT?

@qoomon
Copy link
Owner

qoomon commented Jul 12, 2022

e.g.

changelogGenerator.generateMarkdown(changelogCommits, {
  releaseName: "FooBar",
  customMarkdown: "lorum ipsum",
  messageRegex: ...,
  scopes: [...],
  ...
});

@bastidest
Copy link
Contributor Author

I very much agree. I was being cautious not to break anything and thought i could surgically insert the fix 🥷. I did it properly now and removed the "marking".

I was having a hard time tracing back all object fields, so I started documenting with JSDoc to assist the IDE.

lib/changelogGenerator.js Outdated Show resolved Hide resolved
@qoomon
Copy link
Owner

qoomon commented Jul 12, 2022

LGTM

@qoomon qoomon merged commit d43723d into qoomon:master Jul 12, 2022
@qoomon
Copy link
Owner

qoomon commented Jul 12, 2022

I'll release a new version tomorrow.

@bastidest bastidest deleted the feature/breaking-changelog branch July 12, 2022 19:39
@qoomon
Copy link
Owner

qoomon commented Jul 14, 2022

feel free to try version 1.3.0

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.

always include breaking changes in changelog
2 participants