Skip to content

Conversation

Strift
Copy link
Collaborator

@Strift Strift commented Sep 18, 2025

Pull Request

What does this PR do?

  • Update release drafter configuration to avoid conflicts between main and v1.x branches

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

  • Chores
    • Improved release notes formatting: removed redundant headers, consolidated contributor acknowledgment into a single line, and added a clear "See full changelog" link.
    • Standardized version display with a consistent version template.
    • Ensured drafts target the correct branch/ref by adding a filter-by-commitish option and passing the current Git ref to the release workflow.
    • Cleaned automated bot mentions for clearer contributor lists.

@Strift Strift added this to the Meilisearch PHP v2 milestone Sep 18, 2025
@Strift Strift added the maintenance Anything related to maintenance (CI, tests, refactoring...) label Sep 18, 2025
Copy link

coderabbitai bot commented Sep 18, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Add 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

Cohort / File(s) Summary
Release draft templates
.github/release-draft-template.yml, .github/release-draft-template-v1.yml
Add filter-by-commitish: true; remove the “What’s Changed” header; change footer to “Thanks to $CONTRIBUTORS! 🎉” and add “See full changelog”; keep $CHANGES.
Bot-name replacers (v1 template)
.github/release-draft-template-v1.yml
Add replacers to strip bot mentions (e.g., @dependabot-preview[bot], @dependabot[bot], @meili-bors[bot], @meili-bot).
Release drafter workflow
.github/workflows/release-drafter.yml
Pass commitish: ${{ github.ref_name }} to release-drafter@v6 via the with inputs.

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
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • chore: update ci for v2 #793 — Similar updates to release-drafter templates and workflow inputs, including bot replacers and commitish handling.

Suggested reviewers

  • brunoocasali
  • curquiza
  • norkunas

Poem

I thump my paws: a tidy draft, hooray!
Bots hop aside, their mentions swept away.
Commitish follows the branch I chase,
Notes now neat, in one sweet place.
Carrots up for changelogs clean— a rabbit’s grace! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "chore: update release drafter" is concise, uses a conventional commit prefix, and accurately captures the primary change of updating Release Drafter configuration and templates, so it clearly conveys the PR's main purpose to reviewers.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 09d37f1 and f35efbf.

📒 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)

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

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

Copy link

@coderabbitai coderabbitai bot left a 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" case

Confirmed: $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: Passing commitish 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

📥 Commits

Reviewing files that changed from the base of the PR and between 19220fd and 09d37f1.

📒 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 and version-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 the commitish input and the filter-by-commitish config flag (v6 docs/README).

@Strift Strift force-pushed the chore/update-release-drafter branch from 09d37f1 to f35efbf Compare September 18, 2025 11:55
@Strift Strift merged commit f9c00d3 into main Sep 18, 2025
10 of 11 checks passed
@Strift Strift deleted the chore/update-release-drafter branch September 18, 2025 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Anything related to maintenance (CI, tests, refactoring...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants