Skip to content

simplify & document automated releasing workflow#85

Merged
MusicalNinjaDad merged 2 commits into
mainfrom
releasing
Nov 1, 2025
Merged

simplify & document automated releasing workflow#85
MusicalNinjaDad merged 2 commits into
mainfrom
releasing

Conversation

@MusicalNinjaDad

@MusicalNinjaDad MusicalNinjaDad commented Nov 1, 2025

Copy link
Copy Markdown
Owner

Summary by Sourcery

Improve the GitHub Actions release workflow by adding detailed documentation, simplifying trigger configuration, and removing redundant conditionals.

CI:

  • Add descriptive comments to document automated release process and failure recovery steps
  • Configure workflow to trigger on pushes to main branch and v* tags
  • Remove job-level conditional since triggers now handle branch and tag filtering

@sourcery-ai

sourcery-ai Bot commented Nov 1, 2025

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR streamlines the automated release workflow by relocating release conditions into the workflow triggers, removing redundant job-level checks, and enriching the file with comprehensive documentation.

Flow diagram for failure recovery in release workflow

flowchart TD
  A["Release workflow fails"] --> B["Delete tag"]
  B --> C["Push fixes to main"]
  C --> D["Workflow re-triggered by version.go change"]
  A --> E["Delete tag"]
  E --> F["Manually push new tag"]
  F --> G["Workflow re-triggered by new tag"]
Loading

File-Level Changes

Change Details Files
Add detailed documentation for the release workflow
  • Inserted a header comment summarizing the workflow purpose
  • Outlined version/tag matching requirements
  • Described recovery steps for failed releases
.github/workflows/release.yml
Simplify trigger logic by moving conditions to the on: section
  • Added push triggers for tags matching v* and for the main branch
  • Removed the job-level if conditional guarding version job
.github/workflows/release.yml

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey there - 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.

@codecov

codecov Bot commented Nov 1, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.02%. Comparing base (76418aa) to head (45649b3).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #85   +/-   ##
=======================================
  Coverage   74.02%   74.02%           
=======================================
  Files          11       11           
  Lines         566      566           
=======================================
  Hits          419      419           
  Misses        104      104           
  Partials       43       43           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MusicalNinjaDad MusicalNinjaDad merged commit aac398e into main Nov 1, 2025
11 checks passed
@MusicalNinjaDad MusicalNinjaDad deleted the releasing branch November 1, 2025 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant