Automation to keep Envoy API up to date with latest release (envoyproxy#200)

Signed-off-by: rulex123 <[email protected]>

Author: rulex123

.github/workflows/compare-envoy-versions.yml

@@ -0,0 +1,36 @@
+name: compare-envoy-versions
+on:
+  workflow_call:
+    outputs:
+      target-version:
+        description: "Envoy version we need to update to"
+        value: ${{ jobs.compare-envoy-versions.outputs.target-version }}
+
+jobs:
+  compare-envoy-versions:
+    runs-on: ubuntu-latest
+    outputs:
+      target-version: ${{ steps.compare-latest-to-current-version.outputs.target-version }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Fetch latest Envoy version
+        id: latest-envoy-version
+        run: |
+          echo 'ENVOY_LATEST<<EOF' >> $GITHUB_ENV
+          curl -s https://api.github.com/repos/envoyproxy/envoy/releases/latest | jq -r '.tag_name' >> $GITHUB_ENV
+          echo 'EOF' >> $GITHUB_ENV
+      - name: Read current Envoy version
+        id: current-envoy-version
+        run: |
+          echo 'ENVOY_CURRENT<<EOF' >> $GITHUB_ENV
+          cat envoy_release >> $GITHUB_ENV
+          echo 'EOF' >> $GITHUB_ENV
+      - name: Compare latest to current
+        id: compare-latest-to-current-version
+        run: |
+          if [[ "${{ env.ENVOY_LATEST }}" == "${{ env.ENVOY_CURRENT }}" ]]
+          then
+            echo "::set-output name=target-version::noop"
+          else
+            echo "::set-output name=target-version::${{ env.ENVOY_LATEST }}"
+          fi

.github/workflows/scheduled.yml

@@ -0,0 +1,16 @@
+name: scheduled
+on:
+  schedule:
+    # every Monday at 10
+    - cron:  '0 10 * * 1'
+
+jobs:
+  call-compare-envoy-versions-workflow:
+    uses: ./.github/workflows/compare-envoy-versions.yml
+
+  call-update-protobuf:
+    needs: call-compare-envoy-versions-workflow
+    if: ${{ needs.call-compare-envoy-versions-workflow.outputs.target-version != 'noop' }}
+    uses: ./.github/workflows/update-protobuf.yml
+    with:
+      envoy_version: ${{ needs.call-compare-envoy-versions-workflow.outputs.target-version }}

.github/workflows/update-protobuf.yml

@@ -1,10 +1,11 @@
 name: update-protobuf
 on:
-  workflow_dispatch:
+  workflow_call:
     inputs:
       envoy_version:
         description: 'Envoy version to update to'
         required: true
+        type: string
 
 jobs:
   update-protobuf:
@@ -14,14 +15,14 @@ jobs:
       - name: Run scripts
         working-directory: ./tools/
         run: |
-          ./update-sha.sh ${{ github.event.inputs.envoy_version }} | tee API_SHAS
+          ./update-sha.sh ${{ inputs.envoy_version }} | tee API_SHAS
           ./update-api.sh
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v3
         with:
-          branch: update-protobuf-to-${{ github.event.inputs.envoy_version }}
+          branch: update-protobuf-to-${{ inputs.envoy_version }}
           signoff: true
-          title: '[protobuf] Update protobuf definitions to ${{ github.event.inputs.envoy_version }}'
+          title: '[protobuf] Update protobuf definitions to ${{ inputs.envoy_version }}'
           body: |
             This is an automatic PR created by github action workflow:
             - Updated protobuf files

README.md

@@ -27,18 +27,19 @@ mvn clean package
 More thorough usage examples are still TODO, but there is a basic test implementation in
 [TestMain](server/src/test/java/io/envoyproxy/controlplane/server/TestMain.java).
 
-#### Bring api up-to-date with data-plane-api
-To bring this repository's protobuf files up-to-date with the source
-of truth protobuf files in in envoyproxy/data-plane-api, do the
-following:
-
-1. update [tools/API_SHAS](tools/API_SHAS) (instructions are in the
-   file) and then
-2. run [tools/update-api.sh](tools/update-api.sh) from the `tools`
-   directory.
-3. update envoy-alpine-dev docker image version [EnvoyContainer.java] according to envoy SHA in first point.
-
-#### Releasing a new version
+### Envoy API
+There is automation built into this repo to keep the Envoy API (i.e. protobuf files)
+up to date with the latest available Envoy release.
+
+This automation uses Github Workflows and works as follows: a scheduled workflow runs with
+weekly cadence, and calls a reusable workflow that fetches the latest available Envoy release
+and compares it with the version currently used in the repo.
+
+If the latest available Envoy release doesn't match the version currently used, another
+reusable workflow is called which creates a PR that upgrades the Envoy API to the latest
+available release.
+
+### Releasing a new version
 To release and publish a new version, do the following:
 1. create a personal API token in CircleCI by following the instructions listed [here](https://circleci.com/docs/2.0/managing-api-tokens/#creating-a-personal-api-token)
 2. from terminal, curl the CircleCI API as follows

envoy_release

@@ -0,0 +1 @@
+v1.20.0

tools/update-api.sh

@@ -2,7 +2,6 @@
 
 set -o errexit
 set -o pipefail
-set -o nounset
 set -o xtrace
 
 __dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

tools/update-sha.sh

@@ -60,3 +60,6 @@ UDPA_SHA=\"$UDPA_SHA\"  # $UDPA_DATE
 
 # replace version in EnvoyContainer.java
 sed -i 's/\(envoy-alpine-dev:\).*\(\");\)/\1'"$ENVOY_VERSION"'\2/g'  ../server/src/test/java/io/envoyproxy/controlplane/server/EnvoyContainer.java
+
+# update tag in envoy_release file
+echo $1 > enovy_release