1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2026-06-03 18:35:08 +02:00
Commit Graph

2 Commits

Author SHA1 Message Date
Sam Xie a4c3e5df16 Fix verify_released_changelog.sh (#5616)
related #1682

The previous implementation on #5560 has a bug (it works on my mac
though) where it cannot recognize the released section correctly and
pass every modification to the changelog file. This PR fixes the issue.

Action result if we changed the unreleased section:
https://github.com/open-telemetry/opentelemetry-go/pull/5616/commits/ab9eecb8a8871705e490735f6aff3d41df1624a2
Action result if we changed the released section:
https://github.com/open-telemetry/opentelemetry-go/pull/5616/commits/c751dc1255052164f63cd174b9fc1476b002df23
2024-07-12 07:20:17 +02:00
Sam Xie 30ca54a7dc Protect released changelog in CI (#5560)
resolve #1682

This PR adds a new action in CI to protect released sections in the
changelog from being changed. It compares the released sections in the
changelog from the base branch to the current PR. It fails if a change
happens.

Apply "Unlock Released Changelog" to bypass this check when doing a new
release.

Action result if we changed the unreleased section:
https://github.com/open-telemetry/opentelemetry-go/pull/5560/commits/d640deb435cb54802c6819140ee467ad67b068df
Action result if we changed the released section:
https://github.com/open-telemetry/opentelemetry-go/pull/5560/commits/d672de7a54d97979b4ec83f864f2c1789f6b292a

---

Meaning of `awk '/^\<!-- Released section --\>/ {flag=1} /^\<!--
Released section ended --\>/ {flag=0} flag'`
- `/^\<!-- Released section --\>/ {flag=1}`
  - Matches lines starting with `<!-- Released section -->`.
  - Sets the flag variable to 1 (starting the printing of lines).
- `/^\<!-- Released section ended --\>/ {flag=0}`
  - Matches lines starting with `<!-- Released section ended -->`.
  - Sets the flag variable to 0.
  - So it is ok to change external reference links, like
    ```md 
    [Go 1.22]: https://go.dev/doc/go1.22
    [Go 1.21]: https://go.dev/doc/go1.21
    ```
- `flag` lines are printed only when the flag is 1.

---------

Co-authored-by: Robert Pająk <pellared@hotmail.com>
2024-07-08 11:31:31 -07:00