requarks / changelog-action

GitHub Action to generate changelog from conventional commits
MIT License
128 stars 41 forks source link

More commits than expected missing from changelog #34

Closed sschuberth closed 1 year ago

sschuberth commented 1 year ago

I'm currently trying to figure out why for this project I get this release:

image

Although i the Git history I have:

$ git log --oneline 1.0.2 --not 1.0.1 | grep -vE "(build|docs|other|style)"
8deff4b56 WIP
1c804825d WIP
bcd24bda2 refactor(GitHub): Use the more common `github.token`
da42b9396 test(SpmFunTest): Update expected test results
293ebc435 feat(migrate): Add an option to convert NuGet IDs to the namespace format
dc32462e4 refactor(commands): Move configuration migration to a dedicated command
7d5b27952 refactor(package-curation-providers): Make `toCurationPath()` public
af1cbfc19 deps: update dependency com.github.jmongard.git-semver-plugin to v0.6.4
f6d9972bb deps: update dependency clsx to v2
dc6d4a990 deps: update dependency dev.adamko.dokkatoo:dokkatoo-plugin to v2
10fd8a789 deps: update actions/checkout action to v4
13efe5d48 ci: Exclude a URL link in Markdown from the link check
269e00d61 ci: Update reuse configuration for Docusaurus
b3cf8b807 deps: Update the native-gradle-plugin to version 0.9.27
be7ded29b chore(Gradle): Remove forcing the OkHttp version
924dd15b8 chore(batect): Remove the telemetry setting
1f37f99cd deps: update batect to v0.85.0
42b06ae1e revert(codecov): Go back to action v3 from v4
6cc2f5f8f deps: update graphqlplugin to v6.5.6

In understand that the "WIP" commits are missing because includeInvalidCommits is false by default, but why are the "deps", "ci" and "revert" commits missing as well with the default options as excludeTypes defaults to build,docs,other,style only?

NGPixel commented 1 year ago

deps is not a valid prefix. Use chore(deps) instead.

ci is excluded because build is. One is simply an alias. Remove build from the excluded types and it's gonna work.

revert is not supported right now (not technically part of the spec but is suggested), although it could be added.

sschuberth commented 1 year ago

First of all, thanks for the quick response. I have some further questions:

deps is not a valid prefix. Use chore(deps) instead.

Not valid according to what? This explicitly says "types other than fix: and feat: are allowed". So I guess you're referring to the recommendations of the Angular project?

ci is excluded because build is. One is simply an alias.

Where's that alias defined? At least the Angular recommendations explicitly list these separately.

NGPixel commented 1 year ago

Other types are allowed in the spec but realistically there's no way to account for all possible prefixes that could be used when generating a changelog. There's a full name and icon associated to each. How is the action supposed to know deps should translate to a category named "Dependencies" and the relevant icon?

The aliases are defined here. Angular list them separately but most people use them interchangeably. The minor difference doesn't warrant a separate category IMO. Modifying the build workflow usually involves modifying the ci as well.

sschuberth commented 1 year ago

How is the action supposed to know deps should translate to a category named "Dependencies" and the relevant icon?

Well, via user-provided configuration, I guess...

NGPixel commented 1 year ago

This is getting a bit too complicated for what is supposed to be a simple action. There's no simple way to request such a complex input from the user. The other solution would involve a custom config file the action would read. This is getting way overkill.

sschuberth commented 1 year ago

This is getting way overkill.

I see. I guess I'll have to have a look at one of those overkill-solutions then. Thanks anyway for your insights!

sschuberth commented 1 year ago

deps is not a valid prefix. Use chore(deps) instead.

Sorry, follow-up question: With excludeTypes: "" and includeInvalidCommits: true, shouldn't deps commits be included under "Other Changes"? Because it seems to me they aren't.

sschuberth commented 1 year ago

shouldn't deps commits be included under "Other Changes"? Because it seems to me they aren't.

Same for revert-type commits.