Generate Release Notes automatically

maennchen commented 1 year ago

Automatically generates the notes for a release as they are now. (Can be overridden to add more information)

Reason: Saw that we forgot to publish the latest release. It was still in draft state.

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build b2aaf193d1f714a2e727c17f1c6b6f0956c410be-PR-98

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 6cf039f7272df5d23f69b89b4da4f54128e9fd1d:	0.0%
Covered Lines:	325
Relevant Lines:	325

💛 - Coveralls

whatyouhide commented 1 year ago

@maennchen we generally avoid GitHub releases for Elixir libraries since they don't add much, given we already have the changelog as well as Hex releases. I’m thinking maybe we can get rid of this whole thing?

maennchen commented 1 year ago

@whatyouhide The changelog is currently in the GitHub releases and there’s no file.

I personally find it a lot cleaner than having a changelog file.

GitHub releases also offer better integrations into tools like renovate bot that will automatically show the release notes for the updates.

I would therefore like to stay with this approach.

Is there disadvantages that I‘m overlooking?

whatyouhide commented 1 year ago

The fact that most other libraries we maintain use a CHANGELOG, which feels like the expected thing at this point. Can we move to a CHANGELOG, and then potentially discuss GitHub releases across more libraries?

maennchen commented 1 year ago

@whatyouhide We can for sure have a more generalized discussion.

Which other libraries are you referencing? Just gettext or also other ones?

whatyouhide commented 1 year ago

All libraries that I know of under https://github.com/elixir-lang, and Elixir itself.

maennchen commented 1 year ago

@whatyouhide The elixir language itself& ex_doc use both GitHub releases and a file based changelog.

gen_stage and elixir_make only use a file based changelog.

Currently not even inside the elixir core organisation all parts have the same setup.

Can we do it this way until a standards-discussion has come to a conclusion?

Continue to publish releases
Create a changelog file linking to the github releases for now (adressing your concern about the expectation of a file to exist)
OR: Manually sync releases & file on release

At the same time I would open a mailing list thread discussing a standardized way.

As soon as a conclusion is reached, we will make sure all libraries including this one are in conformance.

whatyouhide commented 1 year ago

Let's close this PR, and use a CHANGELOG file for this repo too please, with the changes in the file. No changelog in the GitHub releases.

whatyouhide commented 1 year ago

Also, Elixir uses GitHub releases for the releases, but there are no release notes attached to that, since the notes are in the CHANGELOG.

whatyouhide commented 1 year ago

To be clear, I think these release notes are not useful:

Listing all commits is something folks can just do by going to the commits 🙃 The point of release notes (that is, a CHANGELOG) is to edit those notes in order to highlight interesting and relevant changes.

maennchen commented 1 year ago

@whatyouhide I honestly believe that file based is the worse option.

If we change a working setup to something else, I would at least like to understand the reason for it which I currently don’t.

I‘m not arguing that the description of the release itself couldn’t be better. The autogenerated ones are helpful to with writing good notes by hand. I‘m only arguing that the releases page is an important place to put the changelog notes.

whatyouhide commented 1 year ago

Consistency is the reason. A CHANGELOG-file-based approach has the same information as GitHub releases, but is consistent with the rest of our repositories.

maennchen commented 1 year ago

@whatyouhide Please make sure to fix the link to the changelog file in the mix.exs.

I would like to at least be consistent with ex_docs. => Changelog entry copied into releases.

This is so that tooling that provides updates will cleanly show the release notes.

I will open a mailing list thread in the elixir mailing list so that all official libraries can be consistent themselves.

coveralls commented 3 months ago

Pull Request Test Coverage Report for Build b2aaf193d1f714a2e727c17f1c6b6f0956c410be-PR-98

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 6cf039f7272df5d23f69b89b4da4f54128e9fd1d:	0.0%
Covered Lines:	325
Relevant Lines:	325

💛 - Coveralls

coveralls commented 3 months ago

Pull Request Test Coverage Report for Build b2aaf193d1f714a2e727c17f1c6b6f0956c410be-PR-98

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 6cf039f7272df5d23f69b89b4da4f54128e9fd1d:	0.0%
Covered Lines:	325
Relevant Lines:	325

elixir-gettext / expo