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: 2 additions & 7 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,8 @@ The CLI (`aws/cli-installer`, published to npm as `@opensearch-project/observabi

## Cutting a release

1. Open a PR that sets `aws/cli-installer/package.json` to the target version (e.g. `0.2.0-beta.1`). Sign commits for DCO (`git commit -s`). Get a maintainer review and merge to `main`.
2. Tag the merged commit and push it:
```
git tag v0.2.0-beta.1 <sha>
git push upstream v0.2.0-beta.1
```
The tag is the release trigger. Merging alone publishes nothing.
1. Open a PR that sets `aws/cli-installer/package.json` to the target version (e.g. `0.3.0`). Sign commits for DCO (`git commit -s`). Get a maintainer review and merge to `main`.
2. Request the release tag by filing a `[GitHub Request]` issue on [opensearch-project/.github](https://github.com/opensearch-project/.github/issues). Maintainers cannot push tags to this repo directly ([.github#531](https://github.com/opensearch-project/.github/issues/531)), so the admins create the tag on your behalf. Give the merged commit SHA and the tag name (`v0.3.0`). See [.github#577](https://github.com/opensearch-project/.github/issues/577) for the exact format. The tag is the release trigger; merging alone publishes nothing.
3. The `release-to-npm` job pauses on the `release-approval` environment. A required reviewer, who cannot be the release author, opens the workflow run and approves the deployment.
4. On approval, the workflow validates the version, runs tests, publishes the CLI to the correct npm dist-tag, and drafts the GitHub release. Fill in the release notes with the component-version matrix from `.env`.

Expand Down
4 changes: 2 additions & 2 deletions aws/cli-installer/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion aws/cli-installer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@opensearch-project/observability-stack",
"version": "0.2.1",
"version": "0.3.0",
"description": "CLI for the Observability Stack",
"type": "module",
"bin": "./bin/cli-installer.mjs",
Expand Down
Loading