Skip to content

Commit

Permalink
Remove create stable version action, add regex for watched branches
Browse files Browse the repository at this point in the history
  • Loading branch information
MitchLillie committed Nov 22, 2024
1 parent 2888c91 commit 16e798c
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 58 deletions.
1 change: 1 addition & 0 deletions .github/workflows/changesets-reminder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ on:
- 2024-07
- 2024-10
- unstable
- 20[0-9][0-9]-[01][1470]
paths:
- 'packages/*/src/**'
- 'packages/*/package.json'
Expand Down
56 changes: 0 additions & 56 deletions .github/workflows/create-stable-version.yml

This file was deleted.

1 change: 1 addition & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ on:
- 2024-04
- 2024-07
- 2024-10
- 20[0-9][0-9]-[01][1470]

concurrency: ${{ github.workflow }}-${{ github.ref }}

Expand Down
5 changes: 3 additions & 2 deletions documentation/versions-and-deploys.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ Like the `unstable` branch, the `internal` branch also publishes snapshot releas
To create a new stable version, you will need to follow these steps:

1. Add the new stable calver version `YYYY-MM` to the list of watched branches in the [`changesets-reminder`](https://github.com/Shopify/ui-extensions/blob/unstable/.github/workflows/changesets-reminder.yml) and [`deploy`](https://github.com/Shopify/ui-extensions/blob/unstable/.github/workflows/deploy.yml) GitHub actions.
1. Run the "create stable version" action.
1. Create a new branch for the calver version you set from the previous step. This branch should be named with the format `YYYY-MM`. You will likely branch off of `unstable` to create this branch.
1. Push your new branch to GitHub. This will trigger the GitHub action that creates a new PR to consume all the changesets you copied over from `unstable` into your new version.
1. Pull down the branch that that was created by the GitHub action (it should have the name `changeset-release/{{BRANCH_NAME}}`). Instead of the patch version changes that were made by the action, update the version of all packages manually to be the first patch release of a new version range. For example, if you are creating a `2025-01` API version, you will set the package versions of all packages to `2025.1.0`. Apply this change to `packages/ui-extensions/package.json`, `packages/ui-extensions/CHANGELOG.md`, `packages/ui-extensions-react/package.json`, and `packages/ui-extensions-react/CHANGELOG.md`.
> Note: do not update the root-level `package.json`.
1. Push your new changes, and make sure you get the PR reviewed by one other member of the [UI Extension Stewards GitHub team](https://github.com/orgs/Shopify/teams/ui-extension-stewards).
1. Update the [`LATEST_STABLE_VERSION`](https://github.com/Shopify/ui-extensions/settings/variables/actions) repository variable to your stable version (i.e. `2025-01`). This ensures means it will be marked with a `latest` npm dist-tag on NPM.
1. Merge the PR, and let robots release the new versions to NPM and tag it appropriately.
1. For any changes from `unstable` that have been incorporated into the new version, delete their changeset files on the `unstable` branch and replace the existing `CHANGELOG.md` files in `unstable` with what was just shipped.
1. Send a message announcing the release. Let teams know that now is the time to update their section's docs and CLI templates.

0 comments on commit 16e798c

Please sign in to comment.