Skip to content

Commit cb89953

Browse files
doc: add RELEASING.md (#23)
1 parent 9e33ea2 commit cb89953

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

tools/cli/RELEASING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Release FOAS CLI
2+
![Action Summary](https://github.com/mongodb/openapi/assets/5663078/b7717227-fdf1-4fa7-816d-a67735c31377)
3+
4+
## Trigger release workflow
5+
6+
- Using our [Release GitHub Action](https://github.com/mongodb/openapi/actions/workflows/release-cli.yml) run a new workflow using `master` and the following inputs:
7+
- Version number: `vX.Y.Z`
8+
- Skip tests: Should be left empty. Only used in case failing tests have been encountered and the team agrees the release can still de done.
9+
- Using an existing tag: Should be left empty (default `false` creates a new tag from `master`). This should be set to `true` only if you want to re-use an existing tag for the release. This can be helpful for rerunning a failed release process in which the tag has already been created.
10+
11+
- Using [GitHub CLI](https://cli.github.com/), run the command
12+
```bash
13+
cd tools/cli
14+
# Make sure to update version_number with the release version
15+
gh workflow run release-cli.yml -f version_number=vX.Y.Z -f skip_tests=false -f use_existing_tag=false
16+
```

0 commit comments

Comments
 (0)