search

open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
288 stars 176 forks source link

Chloggen should generate links for PRs #1627

Closed lmolkova closed 10 hours ago

lmolkova commented 5 days ago

Changelog contains PR numbers which are not automatically recognized as links when they are committed to the repo.

https://github.com/open-telemetry/semantic-conventions/blob/07293edd52e2182f9c18e871bbff44958cf77271/CHANGELOG.md?plain=1#L15

It'd be great to make chloggen produce links for them.

joaopgrassi commented 5 days ago

There could be a way of doing it today, with a custom template https://github.com/open-telemetry/opentelemetry-go-build-tools/blob/main/chloggen/internal/chlog/testdata/custom.tmpl#L5 the only problem is that it's not possible to distinguish between a issue or a PR, since the field today can hold numbers for both.

To really make it work, we would need in chloggen another field for the PR number.

I've sent a proposal, let's see 🤞. In the PR there's an example on how we can generate the PR links in the markdown file.

joaopgrassi commented 5 days ago

Alright, I was unaware that GitHub automatically redirects correctly PRs/Issues, so we don't need changes in the tool. Just a custom template.

Because pull requests are issues, issue and pull request numbers do not overlap in a repository. For example, if you open your first issue in a repository, the number will be 1. If you then open a pull request, the number will be 2

Source: https://docs.github.com/en/rest/using-the-rest-api/issue-event-types?apiVersion=2022-11-28

thanks @mowies !