Skip to content

chore: remove release-drafter, document release process - #93

Merged
skyoo2003 merged 1 commit into
mainfrom
chore/remove-release-drafter
Jul 17, 2026
Merged

skyoo2003 merged 1 commit into
mainfrom
chore/remove-release-drafter

Conversation

@skyoo2003

Copy link
Copy Markdown
Owner

Summary

Remove the redundant release-drafter config/workflow and document the actual Changie + GoReleaser release process.

Related Issue

Fixes #

Changes

  • Remove .github/release-drafter.yml and .github/workflows/release-drafter.yml — release notes are owned by Changie fragments (changes/<tag>.md) and consumed by GoReleaser at tag time, so release-drafter was dead/parallel tooling.
  • Add docs/release.md — Changie fragment → changie batch/merge → tag push → GoReleaser flow, dry-run, and the separate CD image pipeline.
  • Link it from docs/README.md.
  • Fix stale references in CONTRIBUTING.md and .github/pull_request_template.md (they told contributors to hand-edit CHANGELOG.md, which is now generated by changie merge).

Test Plan

  • Docs/CI-config only — no runtime code. Removed workflow no longer references a deleted config; remaining links resolve.

Checklist

  • Self-reviewed the code
  • Added/updated tests — N/A (docs/CI config only)
  • Lint/format passes (golangci-lint run) — N/A (no Go changes)
  • Updated documentation (if applicable)
  • Added a Changie changelog fragment for user-facing changes — N/A (internal tooling/docs only)

…process

Release notes are owned by Changie fragments (changes/<tag>.md) and consumed
by GoReleaser at tag time, so the release-drafter config and workflow were
redundant. Remove both, add docs/release.md describing the real process, and
fix the stale CHANGELOG/release-drafter references in CONTRIBUTING.md and the
PR template.
@sourcery-ai

sourcery-ai Bot commented Jul 17, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Removes the unused release-drafter config/workflow and documents the actual Changie + GoReleaser-based release process, updating contributor docs and templates to point at Changie fragments instead of manual CHANGELOG edits.

File-Level Changes

Change Details Files
Remove legacy release-drafter automation in favor of the existing Changie + GoReleaser release tooling.
  • Delete the release-drafter configuration file from the GitHub metadata.
  • Delete the release-drafter GitHub Actions workflow so it no longer runs in CI.
.github/release-drafter.yml
.github/workflows/release-drafter.yml
Add and surface a dedicated release process document describing the Changie and GoReleaser workflows.
  • Introduce a new release guide covering versioning, fragment creation, batching/merging, tagging, CI release behavior, and dry-run support.
  • Link the new release guide from the docs index under the contributing section.
docs/release.md
docs/README.md
Align contributor guidance and PR checklist with the Changie-based release note generation flow.
  • Update contributor docs to remove references to release-drafter and clarify that release notes come from Changie fragments, including how to add them.
  • Update the pull request template checklist to require a Changie fragment for user-facing changes instead of manual CHANGELOG edits.
CONTRIBUTING.md
.github/pull_request_template.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions Bot added documentation Improvements or additions to documentation ci CI/CD workflows and scripts labels Jul 17, 2026
@skyoo2003 skyoo2003 self-assigned this Jul 17, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@skyoo2003
skyoo2003 merged commit 5995283 into main Jul 17, 2026
9 checks passed
@skyoo2003
skyoo2003 deleted the chore/remove-release-drafter branch July 17, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci CI/CD workflows and scripts documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant