From ee6f92c637fd5f584066780e6f7707bc11bba9da Mon Sep 17 00:00:00 2001 From: Tobias Klauser Date: Mon, 23 Mar 2020 19:23:54 +0100 Subject: [PATCH] contrib, docs: fixes for the backporting guide and script README Add `jq` to backport one-time setup dependencies. It is used in the `contrib/backporting/check-stable` script. Also fix some minor grammatical issues. Signed-off-by: Tobias Klauser --- Documentation/contributing/release/backports.rst | 14 ++++++++------ Documentation/spelling_wordlist.txt | 1 + contrib/backporting/README.md | 6 +++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/Documentation/contributing/release/backports.rst b/Documentation/contributing/release/backports.rst index 35cfbeb9629b..02db5d476b91 100644 --- a/Documentation/contributing/release/backports.rst +++ b/Documentation/contributing/release/backports.rst @@ -1,5 +1,5 @@ .. only:: not (epub or latex or html) - + WARNING: You are looking at unreleased Cilium documentation. Please use the official rendered version released here: http://docs.cilium.io @@ -15,7 +15,7 @@ Backport Criteria ----------------- Committers may nominate PRs that have been merged into master as candidates for -backport into stable_releases if they affect the stable production usage +backport into stable releases if they affect the stable production usage of community users. Backport criteria for current minor release @@ -55,8 +55,8 @@ process for backporting these PRs: One-time setup ~~~~~~~~~~~~~~ -#. The scripts referred to below need to be run in Linux, they do not - work on OSX. You can use the cilium dev VM for this, but you need +#. The scripts referred to below need to be run on Linux, they do not + work on macOS. You can use the cilium dev VM for this, but you need to configure git to have your name and email address to be used in the commit messages: @@ -65,8 +65,8 @@ One-time setup $ git config --global user.name "John Doe" $ git config --global user.email johndoe@example.com -#. Make sure you have your a GitHub developer access token - available. For details, see `contrib/backporting/README.md +#. Make sure you have a GitHub developer access token with the ``public_repos`` + scope available. For details, see `contrib/backporting/README.md `_ #. This guide makes use of several tools to automate the backporting process. @@ -80,6 +80,8 @@ One-time setup +--------------------------------------------------------------+-----------+---------------------------------------------------------+ | git | Yes | N/A (OS-specific) | +--------------------------------------------------------------+-----------+---------------------------------------------------------+ + | jq | Yes | N/A (OS-specific) | + +--------------------------------------------------------------+-----------+---------------------------------------------------------+ | python3 | No | `Python Downloads `_ | +--------------------------------------------------------------+-----------+---------------------------------------------------------+ | `PyGithub `_ | No | ``pip3 install PyGithub`` | diff --git a/Documentation/spelling_wordlist.txt b/Documentation/spelling_wordlist.txt index 99f583b14458..4c96345c9886 100644 --- a/Documentation/spelling_wordlist.txt +++ b/Documentation/spelling_wordlist.txt @@ -329,6 +329,7 @@ jgt jle jlt jne +jq js jset jsge diff --git a/contrib/backporting/README.md b/contrib/backporting/README.md index c1f696fbbb17..45579463611c 100644 --- a/contrib/backporting/README.md +++ b/contrib/backporting/README.md @@ -17,11 +17,11 @@ branch is then needed for backporting into downstream with the help of the ## Example 1. Generate a GitHub developer access token. - You can access directly from https://github.com/settings/tokens or - by open GitHub page and then: User Profile -> Settings -> + You can do this directly from https://github.com/settings/tokens or + by opening GitHub and then navigating to: User Profile -> Settings -> Developer Settings -> Personal access token -> Generate new token - The access token requires access to `public_repo`. + The access token requires access to the `public_repo` scope. If not already done, install `jq` on your system.