Skip to content

Commit

Permalink
resolve comments
Browse files Browse the repository at this point in the history
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
  • Loading branch information
qweeah committed Jul 17, 2023
1 parent 3f593d4 commit 710215e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/community/developer_guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,20 @@ To update or add new dependencies, run `go get <package name>`.
This section needs a lot of love and automation 🙂

:::
### Preparation
### Prerequisites
1. Make sure your GPG is available on GitHub at `https://github.com/<username>.gpg`. This can be added at https://github.com/settings/keys
1. If you haven't already, open PR to add your GPG key to the [`KEYS`](https://github.com/oras-project/oras/blob/main/KEYS) file (see file for instructions)
1. Open a PR to update Github Actions with latest version of golang: replace go version of [binary](https://github.com/oras-project/oras/blob/main/.github/workflows/release-github.yml#L32) and [image](https://github.com/oras-project/oras/blob/main/Dockerfile#L14) to latest stable one

### Request to vote
1. Open a release PR to update oras version: replace [current stable version](https://github.com/oras-project/oras/blob/main/internal/version/version.go#L20) with upcoming release version
1. Open a release PR to update oras version: replace [current version](https://github.com/oras-project/oras/blob/main/internal/version/version.go#L20) with upcoming release version
- The target branch is `main`
- The title should be `bump: tag and release ORAS CLI v<major>.<minor>[-<pre-release>]`
- The title should be `bump: tag and release ORAS CLI v<major>.<minor>.<patch>[-<pre-release>]`
- The description must reference the digest of version bump up commit for voting
1. Send a message to slack channel to call for vote on releasing. If the vote passes, merge the PR.
- The target commit should be the SHA digest of the last commit in the release PR
- Make sure that the PR is merged with `Create a merge commit` option
- (optional) cut off a release branch named `release-<major>.<minor>` if there is not one already
- (optional) cut off a release branch named `release-<major>.<minor>` if not present

### Release
1. Make fresh clone of the repo after all above steps are completed. Create a new tag for the version prefixed with "v" and push the tag directly to the repo. The tag should be created on the voted commit, **NOT** the merge commit.
Expand Down

0 comments on commit 710215e

Please sign in to comment.