EthicalML/awesome-production-machine-learning

Enhancing releases with diff tag PRs

Opened this issue · 3 comments

axsaucedo commented

Currently the github script publishes releases once a month which allows watchers to be notified.

As an added feature we should include the PRs and commits included in the release; now that we have explicit PR namings, we should be able to easily generate a comprehensive summary.

We can explore which tool would be the simplest to achieve this, such as the github-changelog-generator, etc

zhimin-z commented

Currently the github script publishes releases once a month which allows watchers to be notified.

As an added feature we should include the PRs and commits included in the release; now that we have explicit PR namings, we should be able to easily generate a comprehensive summary.

We can explore which tool would be the simplest to achieve this, such as the github-changelog-generator, etc

For each release, the PR/commit history messages would be shown in the release page, why would we explicitly need a change log?

For example, https://github.com/EthicalML/awesome-production-machine-learning/releases/tag/release-2024-03-01
image

axsaucedo commented

It's common practice, you can see most tools create this automatically, such as:

It's a nice to have as opposed to must have, so not something we'd need in the short term, but could be worth in the future - it's backwards compatible (ie tools create it fully historical file) so no rush either as it's idempotent when we choose to add.

  • 😄1
zhimin-z commented

It's common practice, you can see most tools create this automatically, such as:

It's a nice to have as opposed to must have, so not something we'd need in the short term, but could be worth in the future - it's backwards compatible (ie tools create it fully historical file) so no rush either as it's idempotent when we choose to add.

Good idea, but it seems a bit over the top for this list.