From 710215e66db6b11391dc6586a007cf2cd96d3dc6 Mon Sep 17 00:00:00 2001 From: Billy Zha Date: Mon, 17 Jul 2023 02:28:20 +0000 Subject: [PATCH] resolve comments Signed-off-by: Billy Zha --- docs/community/developer_guide.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/community/developer_guide.mdx b/docs/community/developer_guide.mdx index 898efa9d..8fd2b4b0 100644 --- a/docs/community/developer_guide.mdx +++ b/docs/community/developer_guide.mdx @@ -83,20 +83,20 @@ To update or add new dependencies, run `go get `. This section needs a lot of love and automation 🙂 ::: -### Preparation +### Prerequisites 1. Make sure your GPG is available on GitHub at `https://github.com/.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.[-]` + - The title should be `bump: tag and release ORAS CLI v..[-]` - 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-.` if there is not one already + - (optional) cut off a release branch named `release-.` 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.