🐛 Append changelog to new releases

[azeemshaikh38]

• Please check if the PR fulfills these requirements

• Tests for the changes have been added (for bug fixes / features)
• PR title follows the guidelines defined in https://github.com/ossf/scorecard/blob/main/CONTRIBUTING.md#pr-process

• What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
  Adds changelog to new Scorecard releases. Helpful in understanding PRs included in the new release.

• Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
  No.

[github-actions]

Integration tests success for 9c6500f1afb03b7b21a3d77359cac66aa7aff47e

[naveensrinivasan]

https://bestpractices.coreinfrastructure.org/en/criteria/0#0.release_notes

The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes)

I concur with the above ☝️, release notes should be human-readable and not git log.

Here is an example of the release notes which uses the automation of and some manual intervention https://github.com/kubernetes-sigs/kubebuilder/releases/tag/v3.0.0

We could use this https://github.com/kubernetes-sigs/kubebuilder-release-tools#release-notes-generation to generate release notes

[azeemshaikh38]

https://bestpractices.coreinfrastructure.org/en/criteria/0#0.release_notes

The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes)

I concur with the above ☝️, release notes should be human-readable and not git log.

Here is an example of the release notes which uses the automation of and some manual intervention https://github.com/kubernetes-sigs/kubebuilder/releases/tag/v3.0.0

We could use this https://github.com/kubernetes-sigs/kubebuilder-release-tools#release-notes-generation to generate release notes

Sure that sounds good to me. Could you explain on how I would go about automating this? Don't think I understood the kubebuilder tool fully.

[naveensrinivasan]

https://bestpractices.coreinfrastructure.org/en/criteria/0#0.release_notes

The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes)

I concur with the above ☝️, release notes should be human-readable and not git log.
Here is an example of the release notes which uses the automation of and some manual intervention https://github.com/kubernetes-sigs/kubebuilder/releases/tag/v3.0.0
We could use this https://github.com/kubernetes-sigs/kubebuilder-release-tools#release-notes-generation to generate release notes

Sure that sounds good to me. Could you explain on how I would go about automating this? Don't think I understood the kubebuilder tool fully.

Automating release notes generation? Release notes are for Humans so I think automating is always going to be hard.

Also, there is some automation with kubebuilder https://github.com/kubernetes-sigs/kubebuilder-release-tools#release-notes-generation

[azeemshaikh38]

https://bestpractices.coreinfrastructure.org/en/criteria/0#0.release_notes

The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes)

I concur with the above ☝️, release notes should be human-readable and not git log.
Here is an example of the release notes which uses the automation of and some manual intervention https://github.com/kubernetes-sigs/kubebuilder/releases/tag/v3.0.0
We could use this https://github.com/kubernetes-sigs/kubebuilder-release-tools#release-notes-generation to generate release notes

Sure that sounds good to me. Could you explain on how I would go about automating this? Don't think I understood the kubebuilder tool fully.

Automating release notes generation? Release notes are for Humans so I think automating is always going to be hard.

Also, there is some automation with kubebuilder https://github.com/kubernetes-sigs/kubebuilder-release-tools#release-notes-generation

I see. I currently don't have the cycles to look into this. Can we have the git log as a v0 and maybe look into a more human readable changelog later? Else, I'm happy if you want to take this up. Wdyt?

[naveensrinivasan]

Approved. Thanks.

[github-actions]

Integration tests success for c09ac2260ea40f519c0c1cb00ea0acb08bd42dfe

[github-actions]

Integration tests success for d5072608f901996561a049fc820f29554da1b862