Skip to content
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

Remove create-stable-version action and use regexes #2423

Merged
merged 5 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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]
Copy link
Contributor

Choose a reason for hiding this comment

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

Love this! When we we are a 100 year company, we'll need to remember and come back to update this 🥇.

paths:
- 'packages/*/src/**'
- 'packages/*/package.json'
Expand Down
69 changes: 0 additions & 69 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
4 changes: 3 additions & 1 deletion documentation/versions-and-deploys.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +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. Run the "create stable version" action.
1. Create a new branch for the calver version. This branch should be named with the format `YYYY-MM` where the month should be `01`, `04`, `07`, or `10` (we release quarterly). You will 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.
Loading