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

Lack of CHANGELOG.md file #125

Closed
lilien1010 opened this issue Sep 5, 2021 · 8 comments
Closed

Lack of CHANGELOG.md file #125

lilien1010 opened this issue Sep 5, 2021 · 8 comments

Comments

@lilien1010
Copy link
Collaborator

in the lastest 3.2.5 release, the release log is check the CHANGELOG.md xxx
image

but there is no CHANGELOG.md in the repo

@vmihailenco
Copy link
Owner

There are 2 options:

  • change the message to something like "Check commits for details"
  • start maintaining a changelog

Which do you prefer?

@lilien1010
Copy link
Collaborator Author

I'd like to maintain a CHANGELOG.md in the repo,
like this

@vmihailenco
Copy link
Owner

Me too, but I never had enough discipline to do it :) It looks like https://www.conventionalcommits.org/en/v1.0.0/ and some tool to generate a changelog. Do you have any experience with setting up the build for such workflow?

@lilien1010
Copy link
Collaborator Author

I don't have that experience either, But we can try to start with some workflow by learning from other projects.

@vmihailenco
Copy link
Owner

vmihailenco commented Sep 9, 2021

Do you have a good example of Go projects that use conv commits with Git hooks? So far I've only seen JS projects, but they require package.json file...

@lilien1010
Copy link
Collaborator Author

no sure this is what you want
https://github.com/marketplace/actions/auto-generate-changelog

@vmihailenco
Copy link
Owner

Yep, that is useful - thanks. But what is missing is something like https://typicode.github.io/husky/#/ - commit linter that does not require JS (or some way to use husky with Go projects).

@vmihailenco
Copy link
Owner

Changelog should be auto-generated with commitlint - see 22e4d67. Closing.

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

No branches or pull requests

2 participants