Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ name: PR

on:
pull_request:
branches: [master]
branches: [main]
push:
branches: [master]
branches: [main]

concurrency:
group: pr-${{ github.ref }}
# For PRs, use the ref (branch) in the concurrency group so that new pushes cancel any old runs.
# For pushes to main, ideally we wouldn't set a concurrency group, but github actions doesn't
# support conditional blocks of settings, so we use the SHA so the "group" is unique.
group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.sha || github.ref }}
cancel-in-progress: true

permissions: {}
Expand Down
7 changes: 7 additions & 0 deletions change/beachball-7ce5bd99-b0fa-461c-9666-dd4fe07b02c4.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "Update comments",
"packageName": "beachball",
"email": "elcraig@microsoft.com",
"dependentChangeType": "none"
}
1 change: 0 additions & 1 deletion docs/cli/change.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ If you have changes that are not committed yet (i.e. `git status` reports change

```
$ beachball change
Defaults to "origin/master"
There are uncommitted changes in your repository. Please commit these files first:
- a-new-file
```
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ category: doc

# Beachball CLI options

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

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

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For cases where it's necessary to bump packages together, `beachball` also provi

### Configuring version groups

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.
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.

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

## Grouped changelogs

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.
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.

| Name | Type | Description |
| ------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
8 changes: 4 additions & 4 deletions docs/overview/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ To change the `disallowedChangeTypes` for package `foo`, you could add the follo

## Options

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

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

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

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

Expand Down
7 changes: 6 additions & 1 deletion src/types/BeachballOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,14 @@ export interface RepoOptions {
* The target branch. In the repo or CLI config, this can be specified without a remote name
* as long as `repository` is set in `package.json` to allow inferring the correct remote.
*
* This defaults to the default branch of the default remote.
* - The default remote is the one matching `repository` in `package.json`, falling back to
* `upstream` if defined, the first defined remote, or `origin`.
* - The default branch is the remote's default branch if defined, falling back to
* `git config init.defaultBranch` or `master`.
*
* (In the resolved config used internally, the remote name should *usually* be included,
* unless neither a remote name nor `package.json` `repository` was specified.)
* @default 'origin/master'
*/
branch: string;
/**
Expand Down