Skip to content

Commit b2999b8

Browse files
matthewvolkchanceaclark
authored andcommitted
docs: streamline release process in CONTRIBUTING.md (#2923)
Simplify Stage 2 of the release process by including the @bigcommerce/catalyst-makeswift changeset directly in the sync merge commit instead of requiring a separate bump-version branch and PR. Also update the tags section with explicit commands for both packages.
1 parent 108230f commit b2999b8

1 file changed

Lines changed: 16 additions & 23 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -103,40 +103,33 @@ This ensures `integrations/makeswift` remains a faithful mirror of `canary` whil
103103

104104
#### Stage 2: Sync and Release `integrations/makeswift`
105105

106-
2. Follow steps 1-6 under "[Keeping `integrations/makeswift` in sync with `canary`](#keeping-integrationsmakeswift-in-sync-with-canary)"
106+
2. Follow steps 1-6 under "[Keeping `integrations/makeswift` in sync with `canary`](#keeping-integrationsmakeswift-in-sync-with-canary)", with one addition: **include a changeset for `@bigcommerce/catalyst-makeswift` in the sync merge commit** rather than opening a separate PR for it afterwards.
107107

108-
3. **IMPORTANT**: After step 6, you'll need to open another PR into `integrations/makeswift`
109-
- Ensure a local `integrations/makeswift` branch exists and is up to date (`git checkout -B integrations/makeswift origin/integrations/makeswift`)
110-
- Run `git fetch origin` and create a new branch from `integrations/makeswift` (`git checkout -B bump-version origin/integrations/makeswift`)
111-
- From this new `bump-version` branch, run `pnpm changeset`
112-
- Select `@bigcommerce/catalyst-makeswift`
113-
- For choosing between a `patch/minor/major` bump, you should copy the bump from Stage 1. (e.g., if `@bigcommerce/catalyst-core` went from `1.1.0` to `1.2.0`, choose `minor`)
114-
- Example changeset:
108+
- Match the bump type from Stage 1 (e.g., if `@bigcommerce/catalyst-core` went from `1.4.2` to `1.5.0`, use `minor`)
109+
- Create a changeset file in `.changeset/` (e.g., `.changeset/sync-canary-1-5-0.md`):
115110

116111
```
117112
---
118-
"@bigcommerce/catalyst-makeswift": patch
113+
"@bigcommerce/catalyst-makeswift": minor
119114
---
120115
121-
Pulls in changes from the `@bigcommerce/catalyst-core@1.4.1` patch.
116+
Pulls in changes from the `@bigcommerce/catalyst-core@1.5.0` release. For more information, see the [changelog entry](https://github.com/bigcommerce/catalyst/blob/<canary-sha>/core/CHANGELOG.md#150).
122117
```
123118
124-
- Commit the generated changeset file and open a PR to merge this branch into `integrations/makeswift`
125-
- Once merged, you can proceed to the next step
119+
- Replace `<canary-sha>` with the merge commit SHA of the Version Packages PR on `canary` so the link remains stable
120+
- Amend this changeset into the merge commit alongside any other sync changes (changeset cleanup, `core/package.json` and `core/CHANGELOG.md` fixes, etc.)
126121
127-
4. Merge the **Version Packages (`integrations/makeswift`)** PR: Changesets will open another PR (similar to Stage 1) bumping `@bigcommerce/catalyst-makeswift`. Merge it following the same process. This cuts a new release of the Makeswift variant.
122+
3. Merge the **Version Packages (`integrations/makeswift`)** PR: After the sync lands, Changesets will open a PR (similar to Stage 1) bumping `@bigcommerce/catalyst-makeswift`. Merge it following the same process. This cuts a new release of the Makeswift variant.
128123
129-
5. **Tags and Releases:** Confirm tags exist for both `@bigcommerce/catalyst-core` and `@bigcommerce/catalyst-makeswift`. If needed, update `latest` tags in GitHub manually.
124+
4. **Tags and Releases:** Confirm tags exist for both `@bigcommerce/catalyst-core` and `@bigcommerce/catalyst-makeswift`. Update `latest` tags to point to the new releases:
130125
131-
- Push manually:
132-
```
133-
git checkout canary
134-
# Make sure you have the latest code
135-
git fetch origin
136-
git pull
137-
git tag @bigcommerce/catalyst-core@latest -f
138-
git push origin @bigcommerce/catalyst-core@latest -f
139-
```
126+
```bash
127+
git fetch origin --tags
128+
git tag @bigcommerce/catalyst-core@latest @bigcommerce/catalyst-core@<version> -f
129+
git tag @bigcommerce/catalyst-makeswift@latest @bigcommerce/catalyst-makeswift@<version> -f
130+
git push origin @bigcommerce/catalyst-core@latest -f
131+
git push origin @bigcommerce/catalyst-makeswift@latest -f
132+
```
140133

141134
### Additional Notes
142135

0 commit comments

Comments
 (0)