Skip to content

Commit aa65261

Browse files
committed
fixup! Add -h, --help to release.sh
1 parent 132c70e commit aa65261

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

scripts/release.sh

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,35 @@ source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
66
cdroot
77

88
help() {
9-
cat <<-EOH
10-
Usage: ./release.sh [--branch <name>] [--draft] [--dry-run] [--ref <ref>] [--major | --minor | --patch]
9+
cat <<EOH
10+
Usage: ./release.sh [--branch <name>] [--draft] [--dry-run] [--ref <ref>] [--major | --minor | --patch]
1111
12-
This script should be called to create a new release.
12+
This script should be called to create a new release.
1313
14-
When run, this script will display the new version number and optionally a
15-
preview of the release notes. The new version will be selected automatically
16-
based on if the release contains breaking changes or not. If the release
17-
contains breaking changes, a new minor version will be created. Otherwise, a
18-
new patch version will be created.
14+
When run, this script will display the new version number and optionally a
15+
preview of the release notes. The new version will be selected automatically
16+
based on if the release contains breaking changes or not. If the release
17+
contains breaking changes, a new minor version will be created. Otherwise, a
18+
new patch version will be created.
1919
20-
Set --ref if you need to specify a specific commit that the new version will
21-
be tagged at, otherwise the latest commit will be used.
20+
Set --ref if you need to specify a specific commit that the new version will
21+
be tagged at, otherwise the latest commit will be used.
2222
23-
Set --minor to force a minor version bump, even when there are no breaking
24-
changes. Likewise for --major. By default a patch version will be created.
23+
Set --minor to force a minor version bump, even when there are no breaking
24+
changes. Likewise for --major. By default a patch version will be created.
2525
26-
Set --dry-run to run the release workflow in CI as a dry-run (no release will
27-
be created).
26+
Set --dry-run to run the release workflow in CI as a dry-run (no release will
27+
be created).
2828
29-
To mark a release as containing breaking changes, the commit title should
30-
either contain a known prefix with an exclamation mark ("feat!:",
31-
"feat(api)!:") or the PR that was merged can be tagged with the
32-
"release/breaking" label.
29+
To mark a release as containing breaking changes, the commit title should
30+
either contain a known prefix with an exclamation mark ("feat!:",
31+
"feat(api)!:") or the PR that was merged can be tagged with the
32+
"release/breaking" label.
3333
34-
To test changes to this script, you can set --branch <my-branch>, which will
35-
run the release workflow in CI as a dry-run and use the latest commit on the
36-
specified branch as the release commit. This will also set --dry-run.
37-
EOH
34+
To test changes to this script, you can set --branch <my-branch>, which will
35+
run the release workflow in CI as a dry-run and use the latest commit on the
36+
specified branch as the release commit. This will also set --dry-run.
37+
EOH
3838
}
3939

4040
branch=main

0 commit comments

Comments
 (0)