operator-framework / operator-framework/operator-sdk

releases: investigate different method of generating changelog

Open
#4,097 4 comments 0 reactions 1 assignee View on GitHub

@estroz is already working on this.

Since Oct 26, 2020.

kind/documentation kind/feature lifecycle/frozen
Dominant language
Go
Stars
7.7k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Feature Request

Describe the problem you need a feature to resolve.

Currently, the changelog is generated from changelog/fragments in CHANGELOG.md, and soon to be in changelog/generated/<version>.md. The changelog and deleted fragments need to be committed in a release commit. Ideally this release commit would either be smaller or non-existent, which implies that the changelog be committed in some other way or not at all.

Describe the solution you'd like.

My main suggested solution is to use goreleaser's default changelog generator. This means that we'll have to start enforcing a commit message structure, which I think is a reasonable thing to do, and helpful regardless of whether we generate a changelog from them or not.

/kind feature

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.