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

Include PR/Issue links in the changelog #1630

Conversation

joaopgrassi
Copy link
Member

Fixes #1627

Changes

Adds a template for customizing the generated changelog file by chloggen. The template is a copy of the default, but renders links for issues/PR numbers specified in the issues field in the changelog entries.

Merge requirement checklist

@joaopgrassi joaopgrassi added tooling Regarding build, workflows, build-tools, ... Skip Changelog Label to skip the changelog check labels Nov 28, 2024
@joaopgrassi joaopgrassi requested review from a team as code owners November 28, 2024 16:44
@joaopgrassi
Copy link
Member Author

Here's how it will look on current main

Generated changelog updates for user:
## vTODO

### 🛑 Breaking changes 🛑

- `vcs`: Add the VCS metrics inspired by the GitHub Receiver ([#1372](https://github.com/open-telemetry/semantic-conventions/issues/1372))
  Makes the following changes:

  - Add metrics `vcs.change.count`, `vcs.change.duration`, `vcs.change.time_to_approval`, `vcs.repository.count`, `vcs.ref.count`,
    `vcs.ref.lines_delta`, `vcs.ref.revisions_delta`, `vcs.ref.time`, `vcs.contributor.count`
  - The VCS attributes `vcs.change.state`, `vcs.revision_delta.direction` and `vcs.line_change.type` have been added to the registry.
  - The VCS ref attributes have been duplicated to `vcs.ref.base.*` to allow for ref comparisons.
  - The VCS attribute `vcs.ref.type` has been added for simplicity when neither a full head or base ref is necessary.
  - `vcs.repository.change.*` attributes have been deprecated and moved to `vcs.change.*`.
  - `vcs.repository.ref.*` attributes have been deprecated and moved to `vcs.ref.head.*`.

Note: The links will only be added from now on.

.chloggen/CHANGELOG.tmpl Show resolved Hide resolved
Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@lmolkova
Copy link
Contributor

lmolkova commented Dec 2, 2024

@joaopgrassi I'd merge, but I can't update your branch :(

image

@joaopgrassi joaopgrassi merged commit 2d34907 into open-telemetry:main Dec 3, 2024
14 checks passed
@joaopgrassi joaopgrassi deleted the chloggen-generate-pr-links branch December 3, 2024 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog Label to skip the changelog check tooling Regarding build, workflows, build-tools, ...
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Chloggen should generate links for PRs
4 participants