Fix broken workflow examples and stale action version comments
@miroslavpojer arbeitet bereits daran.
Seit 19.11.2026.
Bewertung
Dieses Issue wurde noch nicht bewertet.
Beschreibung
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.
2. examples/release_draft.yml does not run as written
needs: check-tagrefers 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 isskip-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.
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: removeneeds: check-tag(or add the missing job), and rename the input toskip-release-notes-labels.- Workflows: update the version comments to the versions the SHAs point to (
# v7.0.1for checkout,# v7.1.0for setup-python) and add the missing ones. ActionInputs: remove_row_format_link_pr, or makeget_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.ymlpasses workflow validation (for exampleactionlint) and uses only inputs defined inaction.yml.- Every SHA-pinned action in
.github/workflows/has a version comment that matches the tag its SHA points to. ActionInputshas no unused cache attributes, and unit tests still pass.
- Vorherrschende Sprache
- Python
- Sterne
- 12
- Forks
- 0
- Ø Merge
- 1 Min.
- Gemergte PRs (30 T.)
- 6
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus AbsaOSS/generate-release-notes
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 66/100
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 58/100
-
In newly created draft hashes are not linked.Evtl. vergeben @bfs2021 hat das heute übernommen. Offenbug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 35/100
-
Release v1.4.0Evtl. vergeben @miroslavpojer hat das vor 1 Tag übernommen. Offenepic
AbsaOSS/generate-release-notes#358 · 1 zugewiesene Person ·
Alle Issues in AbsaOSS/generate-release-notes
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
abetlen/llama-cpp-python#2424 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Bug IronPython Python 3
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
pyrevitlabs/pyRevit#4184 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 74/100
jqueryscript/awesome-claude-code#1009 ·
-
tests
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 66/100
Maintainer antworten meist innerhalb von 3 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag