-
Notifications
You must be signed in to change notification settings - Fork 105
chore: update release drafter #804
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Caution Review failedThe pull request is closed. WalkthroughAdd commitish-based filtering to release-drafter configs, update release note templates (remove "What's Changed" header, adjust footer to "Thanks to $CONTRIBUTORS! 🎉" and "See full changelog"), add commitish input to the workflow, and include bot-name replacers in the v1 template. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer
participant GH as GitHub Workflow
participant RD as release-drafter@v6
participant CFG as release-draft-template*.yml
Dev->>GH: Push / Tag / PR merge (ref)
GH->>RD: Run action with commitish = github.ref_name
RD->>CFG: Load config (filter-by-commitish = true)
RD->RD: Filter commits by commitish
RD->RD: Generate notes ($CHANGES, Thanks to $CONTRIBUTORS, See full changelog)
alt Replacers present (v1 template)
RD->RD: Remove bot mentions via regex replacers
end
RD-->>Dev: Draft release notes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/release-draft-template-v1.yml (1)
31-34
: Ensure contributors line handles "no contributors" caseConfirmed: $CONTRIBUTORS is an official Release Drafter variable; when no human contributors are found it renders the no-contributors-template value (default: "No contributors").
Action: set no-contributors-template to an empty/alternate phrase or change the line so it won’t produce "Thanks to No contributors! 🎉" (file: .github/release-draft-template-v1.yml lines 31–34)..github/workflows/release-drafter.yml (1)
15-17
: Passingcommitish
as the branch name is correct — pin the action and apply least‑privilege.
- Pin the action: use release-drafter/[email protected] (or an immutable commit SHA, e.g. b1476f6…).
- Add workflow permissions:
permissions:
contents: write
pull-requests: read- Optional: prevent racing updates with a concurrency block:
concurrency:
group: release-drafter-${{ github.ref }}
cancel-in-progress: true
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.github/release-draft-template-v1.yml
(2 hunks).github/release-draft-template.yml
(2 hunks).github/workflows/release-drafter.yml
(1 hunks)
🔇 Additional comments (3)
.github/release-draft-template-v1.yml (1)
3-6
: v1 defaults are sensible.
filter-by-commitish: true
andversion-template: "1.0.0"
align with maintaining the v1 line. No issues..github/release-draft-template.yml (2)
29-35
: Template tweaks look fine — compare link verified.Git tags exist (v1.9.1 → v1.16.1), so $PREVIOUS_TAG will be present for the next v1.x release; add a fallback for an empty $PREVIOUS_TAG if you expect a first v2.x cut to avoid a transient broken compare URL.
3-3
: Good call enabling commitish filtering.
Verified: Release Drafter v6 supports both thecommitish
input and thefilter-by-commitish
config flag (v6 docs/README).
09d37f1
to
f35efbf
Compare
Pull Request
What does this PR do?
main
andv1.x
branchesPR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!
Summary by CodeRabbit