Skip to content

chore: add-patch-release-docs-and-workflow #300

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ryanbas21
Copy link
Collaborator

@ryanbas21 ryanbas21 commented May 21, 2025

JIRA Ticket

TBD

Description

I wanted to have an automated way for us to release patches. Because we merge to main, the cleanest way, as per trunk based development is to do the following:

  • identity bug fix on main
  • fix bug fix on main
  • cherry pick the commit onto the latest release branch
  • verify it
  • push up branch to github
  • execute workflow dispatch provided here, passing in the branch to release from.

the patch release should have a changeset (probably with the cherry-picked commit)

This way we A) have a standard process to release and B) release with provenance even for bug patches.

it's not required, but thought it would be helpful to have.

https://trunkbaseddevelopment.com/branch-for-release/#fix-production-bugs-on-trunk feel free to read more here

Copy link

changeset-bot bot commented May 21, 2025

⚠️ No Changeset found

Latest commit: 3d4878e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

nx-cloud bot commented May 21, 2025

View your CI Pipeline Execution ↗ for commit 3d4878e.

Command Status Duration Result
nx affected -t build typecheck lint test e2e-ci ✅ Succeeded 2m 32s View ↗
nx-cloud record -- nx format:check ✅ Succeeded 3s View ↗

☁️ Nx Cloud last updated this comment at 2025-05-21 04:08:31 UTC

@ryanbas21 ryanbas21 force-pushed the patch-release-script branch from 902816c to 678b7bb Compare May 21, 2025 03:51
@ryanbas21 ryanbas21 force-pushed the patch-release-script branch from 678b7bb to 3d4878e Compare May 21, 2025 04:05
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.55%. Comparing base (8d50e40) to head (3d4878e).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #300   +/-   ##
=======================================
  Coverage   50.55%   50.55%           
=======================================
  Files          29       29           
  Lines        1626     1626           
  Branches      196      196           
=======================================
  Hits          822      822           
  Misses        804      804           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants