Skip to content

chore: generate changelog#177

Open
yejseo01 wants to merge 6 commits intomainfrom
better-changelog
Open

chore: generate changelog#177
yejseo01 wants to merge 6 commits intomainfrom
better-changelog

Conversation

@yejseo01
Copy link
Copy Markdown
Contributor

@yejseo01 yejseo01 commented Apr 2, 2026

Changes

  • make better changelog

@yejseo01 yejseo01 requested a review from a team as a code owner April 2, 2026 10:56
@yejseo01 yejseo01 changed the title chore: better changelog chore: generate better changelog Apr 2, 2026
Comment thread .goreleaser.yaml Outdated
Comment thread .goreleaser.yaml
Copy link
Copy Markdown
Contributor

@awphi awphi left a comment

Choose a reason for hiding this comment

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

Nothing blocking from me but a couple small observations

Comment thread .goreleaser.yaml Outdated
Comment on lines +46 to +48
exclude:
- "^docs:"
- "^chore:"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should also hide refactor, test and style?

Also not sure if we should exclude docs - has some user value

Comment thread .goreleaser.yaml
regexp: '^.*?feat(\([[:word:]]+\))??:.*$'
order: 1
- title: Bug Fixes
regexp: '^.*?fix(\([[:word:]]+\))??:.*$'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this regexp just used for matching or for categorising commits by scope? If it's just the former couldn't we use a simpler expression like ^fix:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

conventional commit format allows optional scopes such as feat(api):... and simplifying the regex won't support it. Simplifying it would also skip any merge commits, which I'm not sure is possible to happen right now, but better to be safe than sorry?

Comment thread .goreleaser.yaml Outdated
@muchzill4
Copy link
Copy Markdown
Contributor

Isn't this PR "generate a changelog", I agree that it's better than nonexistence of changelog, but it's weird to call it "generate better changelog". 😄

@yejseo01 yejseo01 force-pushed the better-changelog branch 3 times, most recently from 2b0226e to 34dc398 Compare April 7, 2026 16:19
@yejseo01 yejseo01 changed the title chore: generate better changelog chore: generate changelog Apr 7, 2026
yejseo01 added 3 commits April 9, 2026 11:34
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
@muchzill4 muchzill4 requested a review from Luke-Parkin April 16, 2026 07:45
Comment thread .goreleaser.yaml
changelog:
disable: true No newline at end of file
use: github
format: "{{ .Message }}{{ if .Logins }} ({{ .Logins | englishJoin }}){{ end }}"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we need to explicitly set format:?

Comment thread .goreleaser.yaml
Comment on lines +51 to +53
- '^(feat|fix|perf|security|breaking|build)(\\([^)]+\\))?(!)?: .*$'
- '^.*!:.*$'
- '^.*BREAKING CHANGE:.*$'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • I think we can drop "BREAKING CHANGE", because we mark them with !
  • I don't think we need build, but would benefit fro chore which I believe is dependabot bumps
  • I'm not sure why we need first and second entry - the regex is hard to parse, can't we just:
include:
   - "^(feat|fix|perf|security|chore)!?:"

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.

5 participants