From af2d897fb1294c22ea36aa9602a657cea88548b9 Mon Sep 17 00:00:00 2001 From: Greg Kurz Date: Tue, 24 Oct 2023 14:54:59 +0200 Subject: [PATCH] doc: Release now uses the official GitHub CLI The hub tool is deprecated. Releases are now based on the official gh CLI. A notable improvement : when properly setup (see [1]), gh allows to directly use HTTPS with one's GitHub credentials, instead of having to setup proper SSH access for pushes to the repo. Adjust the documentation accordingly. Fixes #8302 [1] https://docs.github.com/en/github-cli/github-cli/quickstart#prerequisites Signed-off-by: Greg Kurz --- docs/Release-Process.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Release-Process.md b/docs/Release-Process.md index 9c5c96d66..e311e7c0b 100644 --- a/docs/Release-Process.md +++ b/docs/Release-Process.md @@ -3,15 +3,15 @@ ## Requirements -- [hub](https://github.com/github/hub) - * Using an [application token](https://github.com/settings/tokens) is required for hub (set to a GITHUB_TOKEN environment variable). +- [gh](https://cli.github.com) + * Install and configure the GitHub CLI (gh) as detailed at https://docs.github.com/en/github-cli/github-cli/quickstart#prerequisites . - GitHub permissions to push tags and create releases in Kata repositories. - GPG configured to sign git tags. https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key -- You should configure your GitHub to use your ssh keys (to push to branches). See https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/. - * As an alternative, configure hub to push and fork with HTTPS, `git config --global hub.protocol https` (Not tested yet) * +- `gh auth login` should have configured `git push` and `git pull` to use HTTPS along with your GitHub credentials, + * As an alternative, you can still rely on SSH keys to push branches. See https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account . ## Release Process @@ -81,7 +81,7 @@ $ ./release-notes.sh ${OLD_VERSION} ${NEW_VERSION} > notes.md # Edit the `notes.md` file to review and make any changes to the release notes. # Add the release notes in the project's GitHub. - $ hub release edit -F notes.md "${NEW_VERSION}" + $ gh release edit "${NEW_VERSION}" -F notes.md ``` ### Announce the release