Autochangelog update

[f-leu]

Summary by CodeRabbit

• Chores
  • Updated changelog automation: now excludes draft releases, triggers on completed workflow runs, and validates the presence of the latest release tag.
  • Branch/commit/PR naming now uses the latest release tag; improved date formatting and changelog nesting for clearer output.
  • Checkout now targets the main branch to ensure consistent changelog updates.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Workflow for updating the changelog now triggers on a successful workflow_run completion (manual tag workflow) instead of release.published. It fetches the latest non-draft release via the GitHub API, validates the tag, and uses that tag for branch names, commit messages, and PR metadata; checkout is pinned to main.

Changes

Cohort / File(s)	Summary
Workflow Trigger & Filters .github/workflows/update-changelog.yml	Changed trigger from release.published to workflow_run.completed with success guard; added jq filter to select only non-draft releases.
Tag Retrieval & Usage .github/workflows/update-changelog.yml	Added GitHub API call to set LATEST_TAG; added validation for presence; switched branch naming, commit message, and PR title/body to use ${LATEST_TAG}.
Checkout & Formatting Adjustments .github/workflows/update-changelog.yml	Added explicit ref: main to checkout; adjusted parsing/formatting and date/changelog nesting logic to align with tag-driven flow.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow as Workflow Run
    participant Actions as GitHub Actions
    participant API as GitHub API
    participant Repo as Repository
    participant PR as Pull Request

    Workflow->>Actions: workflow_run.completed (manual tag workflow) [success]
    Actions->>API: GET /releases (filter draft==false)
    API-->>Actions: latest non-draft release (LATEST_TAG)
    Actions->>Repo: checkout ref=main
    Actions->>Repo: create branch chore/update-changelog-${LATEST_TAG}
    Actions->>Repo: commit changelog with ${LATEST_TAG}
    Actions->>PR: open PR titled "chore: update changelog ${LATEST_TAG}"
    PR-->>Actions: PR created

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• split create tag and update changelog workflows to fix race condition #262 — Modifies the same update-changelog workflow and replaces event tag usage with a fetched LATEST_TAG.
• change the automated changelog workflow #256 — Changes automated changelog flow including branch naming and PR creation logic similar to this PR.

Suggested reviewers

• Tzvonimir
• dray92

Poem

🐰 Hopping through CI with a cheer,
I fetch the latest tag so dear,
Drafts are skipped, the branch is born,
Commits and PRs greet the morn,
Changelog shines — the carrots near! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Autochangelog update' is vague and generic. It fails to specify what actually changed in the changelog workflow or what the main improvement is.	Use a more descriptive title that clarifies the specific change, such as 'Refactor changelog workflow to use latest release tag' or 'Update changelog workflow trigger mechanism'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @.github/workflows/update-changelog.yml:
- Around line 68-73: The workflow currently uses LATEST_TAG to build BRANCH_NAME
and proceed with git checkout/commit even if the gh API returned empty; add a
guard after LATEST_TAG is set that checks if LATEST_TAG is empty or null and, if
so, emit a clear error message (e.g., "No latest release tag found") and exit
with non-zero status to stop the job; update references around LATEST_TAG,
BRANCH_NAME, git checkout -B and git commit to only run when the check passes so
you never create malformed branch/PR names.

🧹 Nitpick comments (1)

.github/workflows/update-changelog.yml (1)

39-44: Draft filtering is good; consider prereleases if needed.

If prereleases should also be excluded from the changelog, consider adding a .prerelease == false filter.