Fix broken workflow examples and stale action version comments

オープン
#356 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@miroslavpojer がすでに取り組んでいます。

2026年11月19日 から。

評価

この issue はまだ評価されていません。

説明

bug documentation tech debt

Motivation

These problems were found while reviewing the changes for #355. They already exist on master and are outside the scope of #355. Two of them break the workflows users copy from our documentation.

Observed problems

1. README release example reads an output that does not exist

The "Manual Release Dispatch" example passes ${{ steps.notes.outputs.release_notes }} to the release body, but the action's output is named release-notes (see outputs: in action.yml). The expression evaluates to an empty string, so a workflow copied from the README creates a draft release with an empty body.

https://github.com/AbsaOSS/generate-release-notes/blob/ce11fa9445e7c12eed4cdd2004bcf95929a3c755/README.md#L184

2. examples/release_draft.yml does not run as written
  • needs: check-tag refers to a job that is not defined in the file, so GitHub rejects the workflow.
  • skip-release-notes-label: 'no RN' is not an input of this action; the input is skip-release-notes-labels. GitHub only warns about the unexpected input, so the skip label is silently ignored.

https://github.com/AbsaOSS/generate-release-notes/blob/ce11fa9445e7c12eed4cdd2004bcf95929a3c755/examples/release_draft.yml#L14
https://github.com/AbsaOSS/generate-release-notes/blob/ce11fa9445e7c12eed4cdd2004bcf95929a3c755/examples/release_draft.yml#L64

3. Version comments on pinned actions are out of date

The workflows pin actions by commit SHA, with a comment naming the version. Two of those comments no longer match the commit they annotate:

Pin Comment says Commit is actually Occurrences
actions/checkout@3d3c42e5… # v4 v7.0.1 7 (plus 1 without a comment)
actions/setup-python@6d4fd22b… # v5 v7.1.0 7 (plus 1 without a comment)

Reviewers reading the workflows, including Dependabot PRs, see the wrong major version.

https://github.com/AbsaOSS/generate-release-notes/blob/ce11fa9445e7c12eed4cdd2004bcf95929a3c755/.github/workflows/test.yml#L34-L39

4. Unused cache attribute in ActionInputs

ActionInputs._row_format_link_pr is declared and reset in reset_caches(), but get_row_format_link_pr() never reads or stores it, unlike the other row-format getters.

https://github.com/AbsaOSS/generate-release-notes/blob/ce11fa9445e7c12eed4cdd2004bcf95929a3c755/release_notes_generator/action_inputs.py#L83
https://github.com/AbsaOSS/generate-release-notes/blob/ce11fa9445e7c12eed4cdd2004bcf95929a3c755/release_notes_generator/action_inputs.py#L568

Proposed changes

  • README: change the release body to ${{ steps.notes.outputs.release-notes }}.
  • examples/release_draft.yml: remove needs: check-tag (or add the missing job), and rename the input to skip-release-notes-labels.
  • Workflows: update the version comments to the versions the SHAs point to (# v7.0.1 for checkout, # v7.1.0 for setup-python) and add the missing ones.
  • ActionInputs: remove _row_format_link_pr, or make get_row_format_link_pr() cache its value like the other row-format getters.

Acceptance criteria

  • A workflow copied from the README "Manual Release Dispatch" example creates a draft release whose body contains the generated notes.
  • examples/release_draft.yml passes workflow validation (for example actionlint) and uses only inputs defined in action.yml.
  • Every SHA-pinned action in .github/workflows/ has a version comment that matches the tag its SHA points to.
  • ActionInputs has no unused cache attributes, and unit tests still pass.
主要言語
Python
スター
12
フォーク
0
平均マージ
1分
マージ済み PR(30日)
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

AbsaOSS/generate-release-notes のほかの issue

AbsaOSS/generate-release-notes の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。