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

Update Changelog #987

Open
coolblknerd opened this issue Oct 9, 2021 · 4 comments
Open

Update Changelog #987

coolblknerd opened this issue Oct 9, 2021 · 4 comments

Comments

@coolblknerd
Copy link

What happened

Change long hasn't been updated since v0.7.0 has been released

Expected behavior

Changelog should be updated with every subsequent release to be aware of updates and changes.

Steps to reproduce

N/A

Versions

  • Go: 1.17
  • slack-go/slack: 0.9.5
@kanata2
Copy link
Member

kanata2 commented Oct 29, 2021

Thanks!
I'll consider about the operation of Changelog.
For the time being, please refer to the Release Note.

@karl-johan-grahn
Copy link
Contributor

Common practice is to update CHANGELOG with each pull request. You can enforce it with for example https://github.com/marketplace/actions/changelog-enforcer. Making a release should ideally be done as part of merge to default branch too. The philosophy is that unit tests should cover all cases necessary, and that once you merge to master you automatically get a new release based on the updated change log.

@kanata2
Copy link
Member

kanata2 commented Jul 21, 2022

Thanks for advice, @karl-johan-grahn!

BTW, how about consolidating them into a GitHub release?
This is because that these days I always look at the GitHub release page first recently.

@karl-johan-grahn
Copy link
Contributor

Sure, privately I do GitHub releases for my own projects, it works very well. Here's an example that does a docker publish to GHCR for every semantic tag created: https://github.com/karl-johan-grahn/devopsbot/blob/main/.github/workflows/docker-publish.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants