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

Added a changelog #706

Merged
merged 1 commit into from
Apr 19, 2024
Merged

Added a changelog #706

merged 1 commit into from
Apr 19, 2024

Conversation

scohen
Copy link
Collaborator

@scohen scohen commented Apr 18, 2024

Fixes #626

@scohen
Copy link
Collaborator Author

scohen commented Apr 18, 2024

Note, this is just copied release notes.

@zachallaun
Copy link
Collaborator

My only additional thought is that it would be nice to automate this somehow, since the "What's Changed" portion is generated from commits to main.

@scohen
Copy link
Collaborator Author

scohen commented Apr 19, 2024

My only additional thought

Yep, let's investigate this.

@scohen scohen merged commit 0761255 into main Apr 19, 2024
9 checks passed
@scohen scohen deleted the changelog branch April 19, 2024 18:22
@scohen scohen added this to the 0.6 Release milestone Apr 19, 2024
@crbelaus
Copy link

crbelaus commented Apr 20, 2024

Google provides a GitHub action called Release Please which can automate the CHANGELOG and release generation.

Release Please automates CHANGELOG generation, the creation of GitHub releases, and version bumps for your projects. Release Please does so by parsing your git history, looking for Conventional Commit messages, and creating release PRs.

I have not used it in any of my projects yet as they are kind of small and don't have many releases but I know that it supports Elixir and it is used in multiple Elixir projects such as NextLS (here is an example of an upcoming release).

Not saying that this is the only or even the best tool but just wanted to point out its existence in case it may be helpful.

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.

Adding a CHANGELOG
3 participants