OCM-24478 | chore: add historical changelog automation#3245
OCM-24478 | chore: add historical changelog automation#3245olucasfreitas wants to merge 1 commit into
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR adds a git-cliff configuration (cliff.toml), scripts to generate CHANGELOG.md (hack/changelog-generate.sh) and to create/update a changelog PR (hack/changelog-pr.sh), Makefile targets to run those scripts, and documentation updates (CONTRIBUTING.md, hack/README.md). The generator auto-resolves or downloads a pinned git-cliff binary, supports bootstrap and single-tag modes, and the PR script commits/pushes a tag-named branch and uses the GitHub API to create or update the release changelog PR. Suggested reviewers
🚥 Pre-merge checks | ✅ 11 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (11 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: olucasfreitas The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
Bot
added
the
approved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@hack/changelog-generate.sh`:
- Around line 150-153: The commit range logic drops the repository's first
commit because using root_commit..${current_tag} excludes root_commit; update
the branch that handles i==0 so that when computing commit_range you use just
"${current_tag}" (or otherwise include root_commit by using
"${root_commit}"..="${current_tag}" if your Git supports the inclusive range)
instead of root_commit..${current_tag}; modify the code that sets root_commit
and commit_range (variables root_commit, commit_range, current_tag, and the i==0
conditional) so the first-tag path includes the initial commit in the changelog.
In `@hack/changelog-pr.sh`:
- Line 84: The diff check currently hardcodes "CHANGELOG.md" which ignores the
configurable variable CHANGELOG_FILE; update the git diff invocation in
hack/changelog-pr.sh (the if condition using git -C "${REPO_ROOT}" diff --quiet
-- "CHANGELOG.md") to reference the CHANGELOG_FILE variable instead (e.g., use
"${CHANGELOG_FILE}") so the script respects the configured changelog path and
correctly detects changes for non-default files.
In `@hack/README.md`:
- Around line 33-35: Replace the fenced triple-backtick code blocks used for the
shell examples (the snippet showing ./hack/changelog-generate.sh --bootstrap and
the two other similar examples) with the repository’s configured indented
code-block style so markdownlint MD046 is satisfied; locate the three
occurrences (the example blocks currently fenced at the shown snippets) and
convert them to indented blocks preserving the exact shell commands and spacing.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 6fd2d8a0-633d-402e-9ef8-4df5cb3c5011
📒 Files selected for processing (7)
CHANGELOG.mdCONTRIBUTING.mdMakefilecliff.tomlhack/README.mdhack/changelog-generate.shhack/changelog-pr.sh
olucasfreitas
force-pushed
the
OCM-24478-git-cliff-changelog
branch
from
fd2396d to
678fd30
Compare
|
@coderabbitai resolve |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@hack/changelog-pr.sh`:
- Line 122: Update the PR body template so the ticket keyword uses the required
uppercase form: replace the "Jira:
[${JIRA_KEY}](https://issues.redhat.com/browse/${JIRA_KEY})" string in
hack/changelog-pr.sh with "JIRA:
[${JIRA_KEY}](https://issues.redhat.com/browse/${JIRA_KEY})" (referencing the
JIRA_KEY variable in that template) so the automation recognizes the link.
- Around line 75-77: The script currently persists GITHUB_TOKEN into the
repository git config by setting credential.helper via git -C "${REPO_ROOT}"
config credential.helper, which leaves credentials behind; instead avoid
persistence by either using a non-persistent git -c credential.helper=...
invocation for the specific git commands that need the token or, if you must set
it, immediately remove it after use with git -C "${REPO_ROOT}" config --unset
credential.helper; update the lines around the credential.helper setup (the git
config call referencing REPO_ROOT and GITHUB_TOKEN) to use one of these
approaches so the token is never written permanently to the repo config.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 9e73bf76-51d3-46cb-af25-cd24296d7c03
📒 Files selected for processing (7)
CHANGELOG.mdCONTRIBUTING.mdMakefilecliff.tomlhack/README.mdhack/changelog-generate.shhack/changelog-pr.sh
✅ Files skipped from review due to trivial changes (1)
- CONTRIBUTING.md
✅ Actions performedComments resolved. Approval is disabled; enable |
|
@amandahla please review this when you can, low priority |
1 similar comment
|
@amandahla please review this when you can, low priority |
|
I think keeping the changelog updates in a GitHub workflow is easier to maintain than using a Prow job, especially given the complexity of shell scripting and the GitHub token setup/rotation. wdyt |
| - `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | ||
| - `test`: Adding missing tests or correcting existing tests | ||
|
|
||
| ## Historical Changelog |
There was a problem hiding this comment.
Can we use the same nomenclature from this guide? 'Historical Changelog' sounds a bit off (IMHO)
There was a problem hiding this comment.
Done. Renamed the section to "Release Process and Changelog Automation" to match the provider's CONTRIBUTING.md.
olucasfreitas
force-pushed
the
OCM-24478-git-cliff-changelog
branch
2 times, most recently
from
b5bb678 to
5523db9
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@hack/changelog-pr.sh`:
- Around line 73-82: The script currently sets a repo-local credential.helper
(via the git -C "${REPO_ROOT}" config credential.helper ... block) and unsets
all credential.helper entries in cleanup(), which can leak and clobber
configurations; remove the repo-local credential.helper writes and the cleanup()
unset logic, and instead pass the token-only helper inline for the push command
using git -c credential.helper="!f() { echo username=x-access-token; echo
password=${GITHUB_TOKEN}; }; f" git push ... (i.e., use git -c on the push
invocation rather than modifying config), leaving functions and trap (cleanup)
that are unrelated unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 8511f9bf-2d4c-462f-aa8b-c6e356cde33a
📒 Files selected for processing (7)
CHANGELOG.mdCONTRIBUTING.mdMakefilecliff.tomlhack/README.mdhack/changelog-generate.shhack/changelog-pr.sh
✅ Files skipped from review due to trivial changes (1)
- CONTRIBUTING.md
There was a problem hiding this comment.
🧹 Nitpick comments (2)
Makefile (1)
184-187: 💤 Low valueConsider adding a more helpful error message when TAG is missing.
The
@test -n "$(TAG)"check exits with a generic "Error 1" message. A clearer message would improve the developer experience.💬 Proposed improvement
.PHONY: changelog-generate changelog-generate: - `@test` -n "$(TAG)" + `@test` -n "$(TAG)" || { echo "Error: TAG is required. Usage: make changelog-generate TAG=v1.2.63"; exit 1; } ./hack/changelog-generate.sh --tag "$(TAG)" $(if $(PREVIOUS_TAG),--previous-tag "$(PREVIOUS_TAG)",)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@Makefile` around lines 184 - 187, The changelog-generate target currently uses "`@test` -n \"$(TAG)\"" which yields an opaque "Error 1" when TAG is unset; change the check in the Makefile's changelog-generate recipe to explicitly test TAG and print a clear error (e.g., echo "TAG is required for changelog-generate" to stderr) and exit non-zero if missing so maintainers see a helpful message; update the line that contains the test -n "$(TAG)" to an explicit conditional that echoes the message and exits when TAG is empty.hack/changelog-generate.sh (1)
114-116: ⚡ Quick winAdd timeout to curl to prevent indefinite hangs.
The
curlcall lacks a timeout, which could cause the script to hang indefinitely on network issues during Prow automation or local execution.Suggested fix
echo "Downloading git-cliff v${GIT_CLIFF_VERSION}..." >&2 - curl -fsSL -o "${archive_path}" "${download_url}" + curl -fsSL --max-time 120 --retry 2 -o "${archive_path}" "${download_url}" tar -xzf "${archive_path}" -C "${extract_dir}" --strip-components=1 "git-cliff-${GIT_CLIFF_VERSION}/git-cliff"🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@hack/changelog-generate.sh` around lines 114 - 116, The curl call that downloads git-cliff (using variables download_url, archive_path and GIT_CLIFF_VERSION) has no timeout and can hang; update the curl invocation to include connection and overall timeouts (for example --connect-timeout 10 and --max-time 60 or -m 60) so the script fails fast on network issues and does not block Prow or local runs.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@hack/changelog-generate.sh`:
- Around line 114-116: The curl call that downloads git-cliff (using variables
download_url, archive_path and GIT_CLIFF_VERSION) has no timeout and can hang;
update the curl invocation to include connection and overall timeouts (for
example --connect-timeout 10 and --max-time 60 or -m 60) so the script fails
fast on network issues and does not block Prow or local runs.
In `@Makefile`:
- Around line 184-187: The changelog-generate target currently uses "`@test` -n
\"$(TAG)\"" which yields an opaque "Error 1" when TAG is unset; change the check
in the Makefile's changelog-generate recipe to explicitly test TAG and print a
clear error (e.g., echo "TAG is required for changelog-generate" to stderr) and
exit non-zero if missing so maintainers see a helpful message; update the line
that contains the test -n "$(TAG)" to an explicit conditional that echoes the
message and exits when TAG is empty.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: f94a32bf-b451-4b9b-b5b6-f73858f78136
📒 Files selected for processing (7)
CHANGELOG.mdCONTRIBUTING.mdMakefilecliff.tomlhack/README.mdhack/changelog-generate.shhack/changelog-pr.sh
✅ Files skipped from review due to trivial changes (1)
- CONTRIBUTING.md
Add git-cliff configuration, repository helpers, and a seeded CHANGELOG.md so ROSA can generate a historical changelog after stable tags. Document the post-tag Prow flow and manual fallback commands for changelog regeneration and backfills.
olucasfreitas
force-pushed
the
OCM-24478-git-cliff-changelog
branch
from
5523db9 to
ba7a1c9
Compare
|
Agreed @amandahla, moved the automation to a GitHub Actions workflow ( |
|
@coderabbitai resolve |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/update-changelog.yml:
- Around line 27-31: The checkout step currently leaves credentials persisted
(actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd); update that step to
explicitly disable credential persistence by adding persist-credentials: false
in the step's with: block so the job token isn't written to the repo git config
while keeping ref: master and fetch-depth: 0 unchanged.
In `@hack/changelog-generate.sh`:
- Around line 35-66: The parsing for options --tag, --previous-tag and --output
currently assigns "${2:-}" and then unconditionally does shift which can cause
the script to exit if the value is missing; update the case branches that set
TARGET_TAG, PREVIOUS_TAG and CHANGELOG_FILE to validate that a next token exists
and is not another flag before shifting. Specifically, inside the while/case
handling, check the second positional parameter is non-empty and does not begin
with '-' (for example using a guard like testing "${2:-}" and its first char)
and if invalid print a descriptive error and exit; only then assign
TARGET_TAG/PREVIOUS_TAG/CHANGELOG_FILE and perform the extra shift. This change
applies to the --tag, --previous-tag and --output branches and leaves MODE and
FETCH_TAGS handling unchanged.
In `@hack/changelog-pr.sh`:
- Around line 202-219: The script never applies the required "changelog" label
when updating or creating PRs; after either the existing_PR branch
(existing_pr_number) or the new PR creation (pr_url / response), call the Issues
labels API to set the label. Concretely: when existing_pr_number is set, POST to
"${api_base}/issues/${existing_pr_number}/labels" with
'{"labels":["changelog"]}'; when creating a PR, capture the returned PR number
(jq -r '.number') instead of only .html_url and then POST to
"${api_base}/issues/${new_pr_number}/labels" with '{"labels":["changelog"]}'.
Ensure both paths use the same Authorization/Accept headers and handle failures
similarly to the existing curl calls.
- Around line 76-96: The branch creation currently makes branch_name from the
caller’s HEAD which can include unrelated commits; change the flow to create the
new branch from BASE_BRANCH instead: after generating the changelog and before
adding/committing CHANGELOG_FILE, fetch/update refs in REPO_ROOT and replace the
git checkout -B "${branch_name}" call so it creates the branch starting at
"${BASE_BRANCH}" (not HEAD) ensuring the new branch_name (built from
PR_BRANCH_PREFIX and TARGET_TAG) contains only the changelog change before git
add/commit/push.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: d6991aec-6b26-49c1-8036-7dc91a25ffc2
📒 Files selected for processing (8)
.github/workflows/update-changelog.ymlCHANGELOG.mdCONTRIBUTING.mdMakefilecliff.tomlhack/README.mdhack/changelog-generate.shhack/changelog-pr.sh
✅ Files skipped from review due to trivial changes (1)
- CONTRIBUTING.md
✅ Actions performedComments resolved. Approval is disabled; enable |
2 participants
PR Summary
Add git-cliff configuration, repository helpers, and a seeded
CHANGELOG.mdso ROSA can generate a historical changelog after stable tags. Document the post-tag Prow flow and manual fallback commands for changelog regeneration and backfills.Detailed Description of the Issue
ROSA does not currently keep a historical
CHANGELOG.mdin the repository, and the release-time changelog work needs to stay on Prow rather than being introduced as a GitHub Actions workflow. This change adds the repo-side git-cliff configuration, bootstrap changelog content, and helper scripts that a stable-tag Prow job can call to generate a changelog branch and open a reviewable PR back tomaster.Related Issues and PRs
N/AType of Change
Previous Behavior
ROSA did not have a committed historical changelog, git-cliff configuration, or repo-side scripts that could generate a changelog PR after a stable tag. Release-note grouping only existed in GoReleaser, and no Prow job was wired to maintain a repository changelog.
Behavior After This Change
ROSA now has a historical
CHANGELOG.mdgenerated by git-cliff, a repo-side changelog generation helper, and a PR helper script designed for stable-tag Prow automation. Contributors do not add changelog fragments to feature PRs; instead, stable tags trigger a reviewable historical changelog update flow.How to Test (Step-by-Step)
Preconditions
openshift/releasePR is applied when validating the full Prow flow.Test Steps
./hack/changelog-generate.sh --tag v1.2.63 --previous-tag v1.2.62 --output "$(mktemp)"../hack/changelog-generate.sh --bootstrap.cliff.toml,CHANGELOG.md,hack/changelog-generate.sh, andhack/changelog-pr.sh.make test,make lint, andmake rosa.Expected Results
CHANGELOG.mdfrom stable tags only.Proof of the Fix
./hack/changelog-generate.sh --tag v1.2.63 --previous-tag v1.2.62,make test,make lint,make rosaBreaking Changes
Breaking Change Details / Migration Plan
N/A
Developer Verification Checklist
[JIRA-TICKET] | [TYPE]: <MESSAGE>.make install-hookshas been run in this clone.make testpasses.make lintpasses.make rosapasses.Summary by CodeRabbit
Documentation
Chores