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(auto-changelog): auto-changelog template customization #2907

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ko2in
Copy link
Member

@ko2in ko2in commented Sep 21, 2023

Description

The current changelog file generates by auto-changelog contains the commits relating to the dependency updates by @dependabot which aren't really necessary.

This PR adds a custom template that overrides the compact.hbs used by auto-changelog when generating the changelog data that exclude the commits which have the subject starts with build(deps): bump or build(deps-dev): bump.

Please note that there are also commits which have the subject starts with chore(release): bump, and those are not effected by this PR.

Closes

#2900

This PR supports to generate changelog without including the commits
relating to automatic dependency updates by dependency bot.
@ko2in
Copy link
Member Author

ko2in commented Sep 27, 2023

@lubber-de Any feedback?

@lubber-de
Copy link
Member

lubber-de commented Sep 27, 2023

@lubber-de Any feedback?

Your change basically works.
However, i think we should redesign the whole changelog, not just removing the deps commits, and make more use of the autochangelog and handlebars features.

Something like grouping commits to a respective component section, so something like.

Fixes

Accordion

  • removed the grouping

Modal

  • autofocus did not work

New features

Chore

  • added types

Feed

  • new connected variant

Calendar

  • calendar can now be displayed off canvas

I am not sure, if we would be able to still mention depency sommits, but collect them and only mention the very latest update, so instead of

Dependency updates

build(deps-dev): bump postcss from 8.4.21 to 8.4.22
build(deps-dev): bump postcss from 8.4.22 to 8.4.23
build(deps-dev): bump postcss from 8.4.23 to 8.4.24
build(deps-dev): bump postcss from 8.4.24 to 8.4.25
build(deps-dev): bump postcss from 8.4.25 to 8.4.26

we only output

Dependency updates

postcss from 8.4.21 to 8.4.26

Opinion?

@ko2in
Copy link
Member Author

ko2in commented Sep 28, 2023

@lubber-de Yes, I like your proposition. The difficulty here is not all commit messages are not followed the same convention which would make harder to filter out what the commit is about (fix, feature, etc.)

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.

2 participants