Skip to content

Commit 6a46d2c

Browse files
Update README to reference baseBranch, use "main" as default in examples (#180)
* chore(docs): Update README to reference baseBranch - Adds reference to the `baseBranch` config in the Changesets docs - Updates all references in examples to `main` instead of `master` - `main` is now the default branch in new GitHub projects - This change aligns with the comment in the `baseBranch` section of Changesets docs * remove commit sha from docs URL
1 parent fa2875d commit 6a46d2c

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changesets Release Action
22

3-
This action for [Changesets](https://github.com/atlassian/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on master, the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
3+
This action for [Changesets](https://github.com/atlassian/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
44

55
## Usage
66

@@ -31,7 +31,7 @@ name: Release
3131
on:
3232
push:
3333
branches:
34-
- master
34+
- main
3535

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

@@ -67,7 +67,7 @@ name: Release
6767
on:
6868
push:
6969
branches:
70-
- master
70+
- main
7171
7272
concurrency: ${{ github.workflow }}-${{ github.ref }}
7373
@@ -134,7 +134,7 @@ name: Release
134134
on:
135135
push:
136136
branches:
137-
- master
137+
- main
138138
139139
jobs:
140140
release:
@@ -176,7 +176,7 @@ name: Release
176176
on:
177177
push:
178178
branches:
179-
- master
179+
- main
180180
181181
concurrency: ${{ github.workflow }}-${{ github.ref }}
182182

0 commit comments

Comments
 (0)