Skip to content

feat(release): add release please workflow and docs#4558

Merged
brandtkeller merged 1 commit intomainfrom
3808_release_please
Jan 28, 2026
Merged

feat(release): add release please workflow and docs#4558
brandtkeller merged 1 commit intomainfrom
3808_release_please

Conversation

@brandtkeller
Copy link
Copy Markdown
Member

@brandtkeller brandtkeller commented Jan 26, 2026

Description

Adds support for a release please workflow to manage the next release, begin authoring and iterating on a changelog, as well as reducing cognitive burden and error from manually pushing release tags.

Related Issue

Additional Steps Taken

  • Create a zarf-dev organization github app
  • Install the app on the Zarf repository
  • Add the referenced secrets to the zarf repository
  • Add the app to the bypass list for tag creation ruleset

Note: This is going to be a tough one to test in isolation. The process is only responsible for maintaining a release PR and creating a tag when merged. Should that not work as intended - we can still create the tag manually and push in order to proceed with release processes.

Fixes #3808

Checklist before merging

Signed-off-by: Brandt Keller <brandt.keller@defenseunicorns.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 26, 2026

Deploy Preview for zarf-docs canceled.

Name Link
🔨 Latest commit 5f8b564
🔍 Latest deploy log https://app.netlify.com/projects/zarf-docs/deploys/6977f6cc59b4e10008ee0779

@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread RELEASES.md
git tag -sa vX.Y.Z -m "vX.Y.Z"
git push origin vX.Y.Z
```
* [ ] Update `.release-please-manifest.json` to reflect the new version
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Putting this here to track version syncing effectively - but faintly recall that release please might handle this natively.

@brandtkeller brandtkeller marked this pull request as ready for review January 27, 2026 21:30
@brandtkeller brandtkeller requested review from a team as code owners January 27, 2026 21:30
Copy link
Copy Markdown
Member

@AustinAbro321 AustinAbro321 left a comment

Choose a reason for hiding this comment

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

Seems like a reasonable workflow and good addition, I am not an expert in release please, but given that it requires PR approval and the worse case is a temporary reversion to the manual workflow, I feel good about this

@brandtkeller brandtkeller moved this to PR Review in Zarf Jan 28, 2026
@brandtkeller brandtkeller added this pull request to the merge queue Jan 28, 2026
Merged via the queue into main with commit b4cb102 Jan 28, 2026
43 checks passed
@brandtkeller brandtkeller deleted the 3808_release_please branch January 28, 2026 18:43
@github-project-automation github-project-automation Bot moved this from PR Review to Done in Zarf Jan 28, 2026
AustinAbro321 pushed a commit that referenced this pull request Feb 4, 2026
Signed-off-by: Brandt Keller <brandt.keller@defenseunicorns.com>
Signed-off-by: Austin Abro <austinabro321@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Release Please Integration

2 participants