opentelemetry-go icon indicating copy to clipboard operation
opentelemetry-go copied to clipboard

Protect released changelog in CI

Open XSAM opened this issue 1 year ago • 1 comments

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
      [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.

XSAM avatar Jun 28 '24 21:06 XSAM

This is a great idea!

dmathieu avatar Jul 02 '24 10:07 dmathieu

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.5%. Comparing base (40b6ba1) to head (11360b1).

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #5560   +/-   ##
=====================================
  Coverage   84.5%   84.5%           
=====================================
  Files        271     271           
  Lines      22408   22408           
=====================================
+ Hits       18935   18938    +3     
+ Misses      3141    3138    -3     
  Partials     332     332           

see 2 files with indirect coverage changes

codecov[bot] avatar Jul 05 '24 08:07 codecov[bot]