use github composite action to simplify the flow (perses#584)

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>
sjcrank · Sep 30, 2022 · 2c5d68e · 2c5d68e
1 parent dde5cac
commit 2c5d68e
Showing 4 changed files with 59 additions and 70 deletions.
diff --git a/.github/actions/setup_environment/action.yaml b/.github/actions/setup_environment/action.yaml
@@ -0,0 +1,37 @@
+name: "Setup environment"
+description: "Setup GO or NPM environment"
+inputs:
+  enable_go:
+    description: Whether to enable go specific features, such as caching.
+    default: "false"
+  enable_npm:
+    description: Whether to enable npm specific features, such as caching.
+    default: "false"
+runs:
+  using: composite
+  steps:
+    - name: Install Go
+      uses: actions/setup-go@v3
+      if: inputs.enable_go == 'true'
+      with:
+        go-version: 1.19.x
+    - uses: actions/cache@v3.0.8
+      if: inputs.enable_go == 'true'
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+    - name: Install nodejs
+      uses: actions/setup-node@v3
+      if: inputs.enable_npm == 'true'
+      with:
+        node-version-file: "ui/.nvmrc"
+        registry-url: "https://registry.npmjs.org"
+    - uses: actions/cache@v3.0.8
+      if: inputs.enable_npm == 'true'
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
diff --git a/.github/workflows/build_and_release.yaml → .github/workflows/ci.yaml b/.github/workflows/build_and_release.yaml → .github/workflows/ci.yaml
@@ -1,28 +1,18 @@
-name: build_and_release
+name: ci
 on:
   pull_request:
   push:
-    branches:
-      - main
-    tags:
-      - "v[0-9]+.[0-9]+.[0-9]+*"
+
 jobs:
   build-frontend:
     name: "build-frontend"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Install nodejs
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: "ui/.nvmrc"
-      - uses: actions/cache@v3.0.8
+      - uses: ./.github/actions/setup_environment
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
+          enable_npm: true
 
       - name: Check Tag
         ## This step is verifying that the tag follow the semver
@@ -54,11 +44,9 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Install nodejs
-        uses: actions/setup-node@v3
+      - uses: ./.github/actions/setup_environment
         with:
-          node-version-file: "ui/.nvmrc"
-          registry-url: "https://registry.npmjs.org"
+          enable_npm: true
       - name: Download react build
         uses: actions/download-artifact@v3
         with:
@@ -77,7 +65,7 @@ jobs:
           # as the placeholder for the auth token
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-  go-build-and-release:
+  build:
     name: "go and github release"
     needs: "build-frontend"
     runs-on: ubuntu-latest
@@ -88,16 +76,9 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - name: Install Go
-        uses: actions/setup-go@v3
-        with:
-          go-version: 1.19.x
-      - uses: actions/cache@v3.0.8
+      - uses: ./.github/actions/setup_environment
         with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
+          enable_go: true
       - name: Download react build
         uses: actions/download-artifact@v3
         with:

diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -19,18 +19,11 @@ jobs:
     steps:
     - name: checkout
       uses: actions/checkout@v3
-    - name: install golang
-      uses: actions/setup-go@v3
+    - uses: ./.github/actions/setup_environment
       with:
-        go-version: 1.19.x
+        enable_go: true
     - name: install cue
       run: go install cuelang.org/go/cmd/cue@v0.4.2
-    - uses: actions/cache@v3.0.8
-      with:
-        path: ~/go/pkg/mod
-        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-        restore-keys: |
-          ${{ runner.os }}-go-
     - name: check format
       run: make checkformat
     - name: check go.mod
@@ -41,16 +34,9 @@ jobs:
     steps:
     - name: checkout
       uses: actions/checkout@v3
-    - name: install golang
-      uses: actions/setup-go@v3
-      with:
-        go-version: 1.19.x
-    - uses: actions/cache@v3.0.8
+    - uses: ./.github/actions/setup_environment
       with:
-        path: ~/go/pkg/mod
-        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-        restore-keys: |
-          ${{ runner.os }}-go-
+        enable_go: true
     - name: test
       run: make integration-test
   golangci:
@@ -59,10 +45,10 @@ jobs:
     steps:
     - name: checkout
       uses: actions/checkout@v3
-    - name: install golang
-      uses: actions/setup-go@v3
+    - uses: ./.github/actions/setup_environment
       with:
-        go-version: 1.19.x
+        enable_go: true
+        enable_npm: false
     - name: generate files
       run: make generate
     - name: golangci-lint
@@ -77,10 +63,9 @@ jobs:
     steps:
     - name: checkout
       uses: actions/checkout@v3
-    - name: install golang
-      uses: actions/setup-go@v3
+    - uses: ./.github/actions/setup_environment
       with:
-        go-version: 1.19.x
+        enable_go: true
     - name: install cue
       run: go install cuelang.org/go/cmd/cue@latest
     - name: eval cue schema

diff --git a/.github/workflows/react.yml b/.github/workflows/react.yml
@@ -11,16 +11,9 @@ jobs:
     steps:
       - name: checkout
         uses: actions/checkout@v3
-      - name: install nodejs
-        uses: actions/setup-node@v3
+      - uses: ./.github/actions/setup_environment
         with:
-          node-version-file: "ui/.nvmrc"
-      - uses: actions/cache@v3.0.8
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
+          enable_npm: true
       - name: install deps
         run: cd ./ui && npm ci
       - run: cd ./ui && npm run lint
@@ -30,16 +23,9 @@ jobs:
     steps:
       - name: checkout
         uses: actions/checkout@v3
-      - name: install nodejs
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: "ui/.nvmrc"
-      - uses: actions/cache@v3.0.8
+      - uses: ./.github/actions/setup_environment
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
+          enable_npm: true
       - name: install deps
         run: cd ./ui && npm ci
       - run: cd ./ui && npm run test