[release-14.0] Tooling improvements backports (#12526)

* Improve release process post `v16.0.0 GA` code freeze (#12487) * Update the release instructions document with pre-requisites for release team Signed-off-by: Florent Poinsard <[email protected]> * Add Do Not Merge to release Pull Request upon creation Signed-off-by: Florent Poinsard <[email protected]> --------- Signed-off-by: Florent Poinsard <[email protected]> * Block merge if the `Do Not Merge` label is set (#12489) * Block Merge if the label is set Signed-off-by: Florent Poinsard <[email protected]> * fix echo syntax Signed-off-by: Florent Poinsard <[email protected]> --------- Signed-off-by: Florent Poinsard <[email protected]> * fix typo Signed-off-by: Florent Poinsard <[email protected]> --------- Signed-off-by: Florent Poinsard <[email protected]>
vitessio · Mar 7, 2023 · 2536119 · 2536119
1 parent 752cd50
commit 2536119
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 15 deletions.
diff --git a/.github/workflows/release_notes_label.yml b/.github/workflows/release_notes_label.yml
@@ -14,21 +14,12 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository == 'vitessio/vitess'
     steps:
-      - uses: mheap/github-action-required-labels@v1
-        name: Check release notes label
-        id: required_label
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          mode: exactly
-          count: 0
-          labels: "release notes (needs details)"
-
-      - name: Print helper
-        if: failure() && steps.required_label.outcome == 'failure'
+      - name: Release Notes label
         run: |
-          echo The "release notes (needs details)" label is set. The changes made in this Pull Request need to be documented in the release notes summary "('./doc/releasenotes/14_0_0_summary.md')". Once documented, the "release notes (needs details)" label can be removed.
-          exit 1
+          if [[ "${{contains( github.event.pull_request.labels.*.name, 'release notes (needs details)')}}" == "true" ]]; then
+            echo The "release notes (needs details)" label is set. The changes made in this Pull Request need to be documented in the release notes summary "('./doc/releasenotes/16_0_0_summary.md')". Once documented, the "release notes (needs details)" label can be removed.
+            exit 1
+          fi
 
       - name: Check type and component labels
         env:
@@ -50,3 +41,32 @@ jobs:
             echo "Expecting PR to have label 'Type: ...'"
             exit 1
           fi
+
+      - name: Check NeedsWebsiteDocsUpdate and NeedsDescriptionUpdate are off
+        env:
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+        run: |
+          LABELS_JSON="/tmp/labels.json"
+          # Get labels for this pull request
+          curl -s \
+            -H 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \
+            -H "Accept: application/vnd.github.v3+json" \
+            -H "Content-type: application/json" \
+            "https://api.github.com/repos/${GITHUB_REPOSITORY}/issues/${PR_NUMBER}/labels" \
+            > "$LABELS_JSON"
+          if cat ${LABELS_JSON} | jq -r '.[].name ' | grep -q 'NeedsDescriptionUpdate' ; then
+            echo "Expecting PR to not have the NeedsDescriptionUpdate label, please update the PR's description and remove the label."
+            exit 1
+          fi
+          if cat ${LABELS_JSON} | jq -r '.[].name ' | grep -q 'NeedsWebsiteDocsUpdate' ; then
+            echo "Expecting PR to not have the NeedsWebsiteDocsUpdate label, please update the documentation and remove the label."
+            exit 1
+          fi
+          
+
+      - name: Do Not Merge label
+        run: |
+          if [[ "${{contains( github.event.pull_request.labels.*.name, 'Do Not Merge')}}" == "true" ]]; then
+            echo "This PR should not be merged. The 'Do Not Merge' label is set. Please unset it if you wish to merge this PR."
+            exit 1
+          fi
diff --git a/doc/internal/ReleaseInstructions.md b/doc/internal/ReleaseInstructions.md
@@ -118,9 +118,17 @@ Create the `settings.xml` in the `$HOME/.m2/` directory as described in their [i
 
 ## Release Cutover 
 
-In this section we describe our current release process. We begin with a short [**overview**](#overview).
+In this section we describe our current release process. We begin with a list of [**pre-requisites for the release team**](#pre-requisites) and with a short [**overview**](#overview).
 The release process is divided into three parts: [**Pre-Release**](#pre-release), [**Release**](#release), [**Post-Release**](#post-release), which are detailed after the overview.
 
+### Pre-Requisites
+
+This section highlights the different pre-requisites the release team has to meet before releasing.
+
+- The tool `gh` must be installed locally and ready to be used.
+- You must have access to the Java release, more information in the [**Java Packages**](#java-packages) section.
+- You must be able to create branches and have admin right on the `vitessio/vitess` and `planetscale/vitess-operator` repositories.
+
 ### Overview
 
 #### Schedule