Skip to content

Commit d90ab59

Browse files
DEVDOCS-6672 - Add note that catalyst main branch is deprecated (#1226)
<!-- Ticket number or summary of work --> # [DEVDOCS-6672] ## What changed? <!-- Provide a bulleted list in the present tense --> * Updated Catalyst versioning documentation to note that the `main` branch has ben deprecated. ## Release notes draft * Updated Catalyst versioning documentation to note that the `main` branch has ben deprecated. ping @jamesqquick @CNanninga [DEVDOCS-6672]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6672?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent 8cd6b5e commit d90ab59

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

docs/storefront/catalyst/getting-started/versioning.mdx

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@ Catalyst follows a structured versioning approach to distinguish between stable
44

55
To stay updated on our releases, check out the Catalyst [releases page](https://github.com/bigcommerce/catalyst/releases) and the [changelog](https://github.com/bigcommerce/catalyst/blob/canary/core/CHANGELOG.md) on GitHub.
66

7+
<Callout type='warning'>
8+
The `main` branch is deprecated. The `canary` branch is now the default branch
9+
for the Catalyst repository and should be used instead of `main`.
10+
</Callout>
11+
712
## How we use branches
813

9-
The `canary` branch contains the latest code in development and is the default branch for the Catalyst repository instead of `main`. Note that the most recent commit in `canary` may not be stable.
14+
The `canary` branch contains the latest code in development and is the default branch for the Catalyst repository. Note that the most recent commit in `canary` may not be stable.
1015

1116
For the most recent stable code, refer to [How we use tags](#how-we-use-tags) below.
1217

@@ -81,17 +86,17 @@ While the exact steps you need to follow vary widely depending on how you've con
8186
git merge @bigcommerce/catalyst-makeswift@latest
8287
```
8388

84-
<Callout type="warning">
85-
If you originally created your Catalyst project based on the version of
86-
Catalyst without Makeswift, you will need to merge the latest
87-
`@bigcommerce/catalyst-core@latest` tag into your interim branch instead of
88-
the `@bigcommerce/catalyst-makeswift@latest` tag.
89+
<Callout type='warning'>
90+
If you originally created your Catalyst project based on the version of
91+
Catalyst without Makeswift, you will need to merge the latest
92+
`@bigcommerce/catalyst-core@latest` tag into your interim branch instead of
93+
the `@bigcommerce/catalyst-makeswift@latest` tag.
8994
</Callout>
9095

9196
5. Resolve any merge conflicts that arise. After resolving any merge conflicts, open a new PR in GitHub to merge your `your-interim-sync-branch` into `your-primary-development-branch`. This PR should be code reviewed and approved by your team before the next steps.
9297

9398
6. Once your PR is approved, the next step is to incorporate the merge commit from `your-interim-sync-branch` into `your-primary-development-branch`. There are a few ways to do this, and the best approach for you will depend on your workflow. Here are a couple of options:
94-
99+
95100
- **Option 1: Merge your interim branch into your primary development branch using the GitHub UI:** This is the recommended approach if you are not comfortable with using the command line.
96101

97102
- **Option 2: Rebase your primary development branch on top of your interim branch release:** This is the recommended approach if you are comfortable with using the command line, and want to keep your commit history clean.
@@ -101,13 +106,13 @@ While the exact steps you need to follow vary widely depending on how you've con
101106
git rebase your-interim-sync-branch
102107
```
103108

104-
<Callout type="info" emoji="ℹ️">
105-
Regardless of which option you choose, your goal is to incorporate the merge
106-
commit (the commit with two parent commits) from `your-interim-sync-branch`
107-
into `your-primary-development-branch`. This has the effect of establishing a
108-
new merge base for your primary development branch, so that the next time you
109-
pull in updates from `upstream`, you will not have to resolve any merge
110-
conflicts that you've already resolved in your interim branch.
109+
<Callout type='info'>
110+
Regardless of which option you choose, your goal is to incorporate the merge
111+
commit (the commit with two parent commits) from `your-interim-sync-branch`
112+
into `your-primary-development-branch`. This has the effect of establishing a
113+
new merge base for your primary development branch, so that the next time you
114+
pull in updates from `upstream`, you will not have to resolve any merge
115+
conflicts that you've already resolved in your interim branch.
111116
</Callout>
112117

113118
7. If you went with option 2 above, you have one more step to complete. Push your changes to the remote `your-primary-development-branch`, which will automatically close the PR you opened in step 5:

0 commit comments

Comments
 (0)