Skip to content

Commit 9bcd8b3

Browse files
committed
Updates for beachball master/main rename
1 parent 2b61e4a commit 9bcd8b3

7 files changed

Lines changed: 22 additions & 11 deletions

File tree

.github/workflows/pr.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: PR
55

66
on:
77
pull_request:
8-
branches: [master]
8+
branches: [main]
99
push:
10-
branches: [master]
10+
branches: [main]
1111

1212
concurrency:
1313
group: pr-${{ github.ref }}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "none",
3+
"comment": "Update comments",
4+
"packageName": "beachball",
5+
"email": "elcraig@microsoft.com",
6+
"dependentChangeType": "none"
7+
}

docs/cli/change.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ If you have changes that are not committed yet (i.e. `git status` reports change
5959

6060
```
6161
$ beachball change
62-
Defaults to "origin/master"
6362
There are uncommitted changes in your repository. Please commit these files first:
6463
- a-new-file
6564
```

docs/cli/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ category: doc
77

88
# Beachball CLI options
99

10-
For the latest full list of supported options, see `CliOptions` [in this file](https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts).
10+
For the latest full list of supported options, see `CliOptions` [in this file](https://github.com/microsoft/beachball/blob/main/src/types/BeachballOptions.ts).
1111

1212
**Most options can also be specified in the [configuration file](../overview/configuration)**, which is generally preferable as it's easier to read and maintain.
1313

docs/concepts/groups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For cases where it's necessary to bump packages together, `beachball` also provi
2626
2727
### Configuring version groups
2828

29-
Groups can be added to the [configuration file](../overview/configuration). See the [`VersionGroupOptions` source](https://github.com/microsoft/beachball/blob/master/src/types/ChangelogOptions.ts) for full details.
29+
Groups can be added to the [configuration file](../overview/configuration). See the [`VersionGroupOptions` source](https://github.com/microsoft/beachball/blob/main/src/types/ChangelogOptions.ts) for full details.
3030

3131
| Name | Type | Description |
3232
| ----------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -56,7 +56,7 @@ If you only want to publish or record changes for certain packages, you should u
5656

5757
## Grouped changelogs
5858

59-
To show changes for multiple packages in one change file, use the `changelog.groups` option. See the [`ChangelogGroupOptions` source](https://github.com/microsoft/beachball/blob/master/src/types/ChangelogOptions.ts) for full details.
59+
To show changes for multiple packages in one change file, use the `changelog.groups` option. See the [`ChangelogGroupOptions` source](https://github.com/microsoft/beachball/blob/main/src/types/ChangelogOptions.ts) for full details.
6060

6161
| Name | Type | Description |
6262
| ------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |

docs/overview/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ To change the `disallowedChangeTypes` for package `foo`, you could add the follo
6767

6868
## Options
6969

70-
For the latest full list of supported options, see `RepoOptions` [in this file](https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts).
70+
For the latest full list of supported options, see `RepoOptions` [in this file](https://github.com/microsoft/beachball/blob/main/src/types/BeachballOptions.ts).
7171

7272
"Applies to" indicates where the settings can be specified: repo-level config or package-level config.
7373

@@ -100,10 +100,10 @@ For the latest full list of supported options, see `RepoOptions` [in this file](
100100
| `tag` | `string` | `'latest'` | repo, package | dist-tag for npm when published |
101101
| `transform` | [`TransformOptions`][4] | | repo | transformations for change files |
102102

103-
[1]: https://github.com/microsoft/beachball/blob/master/src/types/ChangeFilePrompt.ts
104-
[2]: https://github.com/microsoft/beachball/blob/master/src/types/ChangelogOptions.ts
103+
[1]: https://github.com/microsoft/beachball/blob/main/src/types/ChangeFilePrompt.ts
104+
[2]: https://github.com/microsoft/beachball/blob/main/src/types/ChangelogOptions.ts
105105
[3]: ../concepts/groups#version-groups
106-
[4]: https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts
106+
[4]: https://github.com/microsoft/beachball/blob/main/src/types/BeachballOptions.ts
107107
[5]: #determining-the-target-branch-and-remote
108108
[6]: #glob-matching
109109

src/types/BeachballOptions.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,14 @@ export interface RepoOptions {
6969
* The target branch. In the repo or CLI config, this can be specified without a remote name
7070
* as long as `repository` is set in `package.json` to allow inferring the correct remote.
7171
*
72+
* This defaults to the default branch of the default remote.
73+
* - The default remote is the one matching `repository` in `package.json`, falling back to
74+
* `upstream` if defined, the first defined remote, or `origin`.
75+
* - The default branch is the remote's default branch if defined, falling back to
76+
* `git config init.defaultBranch` or `master`.
77+
*
7278
* (In the resolved config used internally, the remote name should *usually* be included,
7379
* unless neither a remote name nor `package.json` `repository` was specified.)
74-
* @default 'origin/master'
7580
*/
7681
branch: string;
7782
/**

0 commit comments

Comments
 (0)