From 0d40ccb737e2f6ff05e1ec1edc411f10b775dc25 Mon Sep 17 00:00:00 2001 From: Jon Huhn Date: Wed, 9 Dec 2020 10:07:08 -0600 Subject: [PATCH] docs(release): clarify remotes in release guide (#2166) This change makes clear that `git push` commands in the release process should go to the remote representing the main repo, not forks. It changes the example origin name from `origin` to `upstream` to reduce accidental pushes to forks and better stand out in command snippets. Signed-off-by: Jon Huhn --- docs/release_guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/release_guide.md b/docs/release_guide.md index 87aadfc81d..964cad0735 100644 --- a/docs/release_guide.md +++ b/docs/release_guide.md @@ -17,9 +17,9 @@ Identify the base commit in the `main` branch for the release and cut a release $ git checkout -b release- # ex: git checkout -b release-v0.4 0d05587 ``` -Push the release branch to origin. +Push the release branch to the main repo (not fork), identified here by the `upstream` remote. ```console -$ git push origin release- # ex: git push origin release-v0.4 +$ git push upstream release- # ex: git push upstream release-v0.4 ``` ## Update release branch with versioning changes @@ -36,12 +36,12 @@ The pull request must be reviewed and merged before proceeding to the next step. ## Create and push a Git tag Once the release is ready to be published, create and push a Git tag from the release branch in -the main repo (not fork). +the main repo (not fork), identified here by the `upstream` remote. ```console $ export RELEASE_VERSION= # ex: export RELEASE_VERSION=v0.4.0 $ git tag -a "$RELEASE_VERSION" -m "" -$ git push origin "$RELEASE_VERSION" +$ git push upstream "$RELEASE_VERSION" ``` A [GitHub Action](/.github/workflows/release.yml) is triggered when the tag is pushed. @@ -67,7 +67,7 @@ make chart-readme ## Create a Helm chart release * create a Git tag from main in the format `chart/x.x.x` where `x.x.x` is the chart version -* push the Git tag to origin +* push the Git tag to the main repo (not fork) * GitHub Actions runs [helm-gh-pages](https://github.com/stefanprodan/helm-gh-pages) that packages the charts, updates `index.yaml` and pushes the changes to `gh-pages` branch * GitHub Pages publishes the new version, making the chart available at `https://openservicemesh.github.io/osm`