Fix broken workflow examples and stale action version comments

Open
#356 0 comments 0 reactions 1 assignee View on GitHub

@miroslavpojer is already working on this.

Since Nov 19, 2026.

Assessment

This issue has not been assessed yet.

Description

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.
Dominant language
Python
Stars
12
Forks
0
Avg merge
1m
Merged PRs (30d)
6

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/generate-release-notes

All issues in AbsaOSS/generate-release-notes

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.