Skip to content

Commit 8bad2e9

Browse files
jorgemoyajamesqquick
authored andcommitted
chore: update contributing file with some notes from latest release (#2841)
* chore: update contributing file with some notes from latest release * chore: add info about pushing tags * fix: remove duplicate line
1 parent 534f616 commit 8bad2e9

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ In order to complete the following steps, you will need to have met the followin
6060
>
6161
> - The `name` field in `core/package.json` should remain `@bigcommerce/catalyst-makeswift`
6262
> - The `version` field in `core/package.json` should remain whatever the latest published `@bigcommerce/catalyst-makeswift` version was
63+
> - The latest release in `core/CHANGELOG.md` should remain whatever the latest published `@bigcommerce/catalyst-makeswift` version was
6364
6465
4. After resolving any merge conflicts, open a new PR in GitHub to merge your `sync-integrations-makeswift` into `integrations/makeswift`. This PR should be code reviewed and approved before the next steps.
6566

@@ -104,14 +105,35 @@ This ensures `integrations/makeswift` remains a faithful mirror of `canary` whil
104105
- From this new `bump-version` branch, run `pnpm changeset`
105106
- Select `@bigcommerce/catalyst-makeswift`
106107
- 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`)
108+
- Example changeset:
109+
110+
```
111+
---
112+
"@bigcommerce/catalyst-makeswift": patch
113+
---
114+
115+
Pulls in changes from the `@bigcommerce/catalyst-core@1.4.1` patch.
116+
```
117+
107118
- Commit the generated changeset file and open a PR to merge this branch into `integrations/makeswift`
108119
- Once merged, you can proceed to the next step
109120
110121
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.
111122
123+
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+
125+
- Push manually:
126+
```
127+
git checkout canary
128+
# Make sure you have the latest code
129+
git fetch origin
130+
git pull
131+
git tag @bigcommerce/catalyst-core@latest -f
132+
git push origin @bigcommerce/catalyst-core@latest -f
133+
```
134+
112135
### Additional Notes
113136
114-
- **Tags and Releases:** Confirm tags exist for both `@bigcommerce/catalyst-core` and `@bigcommerce/catalyst-makeswift`. If needed, update `latest` tags in GitHub manually.
115137
- **Release cadence:** Teams typically review on Wednesdays whether to cut a release, but you may cut releases more frequently as needed.
116138
117139
## Other Ways to Contribute

0 commit comments

Comments
 (0)