🎨 improve gitops template (#45)

* 🎨 add npm token

* 📝 update gitops doc for npm token

* 🎨 add gradle cache secrets

* 📝 add gradle cache doc

* 🎨 add docker tag as output

* 🎨 add gitopsenabled prop

* 🎨 change workflow name

* Revert "🎨 add gitopsenabled prop"

This reverts commit f00cd74.

* Revert ":art: add docker tag as output"

This reverts commit 3209e44.

* Revert ":memo: add gradle cache doc"

This reverts commit 1315562.

* Revert ":art: add gradle cache secrets"

This reverts commit f9be8dc.

* 📝 add discussion link

* 🚚 rename docker image name

* 🚚 move comment

Author: flaxel

.github/workflows/template_gitops.yml

@@ -13,6 +13,10 @@ on:
         required: false
         type: boolean
         default: true
+      dockerimage:
+        required: false
+        type: string
+        default: private/${{ github.event.repository.name }}
       gitopsdev:
         required: false
         type: string
@@ -22,22 +26,20 @@ on:
       gitopsprod:
         required: false
         type: string
-      image:
-        required: false
-        type: string
-        default: private/${{ github.event.repository.name }}
     secrets:
       docker_username:
         required: true
       docker_password:
         required: true
       gitops_token:
         required: true
+      npm_token:
+        required: false
 
 jobs:
   gitops:
 
-    name: Deploy
+    name: GitOps
     runs-on: ubuntu-20.04
 
     if: github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
@@ -58,9 +60,12 @@ jobs:
           dockerusername: ${{ secrets.docker_username }}
           dockerpassword: ${{ secrets.docker_password }}
           dockerenabled: ${{ inputs.dockerenabled }}
-          dockerbuildargs: ${{ inputs.dockerbuildargs }}
+          # remove npm token if feature is available: https://github.com/github-community/community/discussions/17554
+          dockerbuildargs: |
+            ${{ inputs.dockerbuildargs }}
+            NPM_TOKEN=${{ secrets.npm_token }}
           dockerbuildtarget: ${{ inputs.dockerbuildtarget }}
-          dockerimage: ${{ inputs.image }}
+          dockerimage: ${{ inputs.dockerimage }}
           gitopstoken: ${{ secrets.gitops_token }}
           gitopsdev: ${{ inputs.gitopsdev }}
           gitopsstage: ${{ inputs.gitopsstage }}

README.md

@@ -101,6 +101,8 @@ jobs:
       docker_username: ${{ <your-docker-username> }}
       # password for the docker registry
       docker_password: ${{ <your-docker-password> }}
+      # optional: token to pull private npm packages
+      npm_token: ${{ <your-docker-password> }}
 ```
 </details>
 
@@ -283,10 +285,6 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
 ## License 📄
 
 This project is licensed under the Apache-2.0 License - see the [LICENSE.md](LICENSE) file for details.
-
-[1]: https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
-[2]: https://github.com/Staffbase/gha-workflows/releases
-
 
 <table>
   <tr>
@@ -300,3 +298,6 @@ This project is licensed under the Apache-2.0 License - see the [LICENSE.md](LIC
     </td>
   </tr>
 </table>
+
+[1]: https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
+[2]: https://github.com/Staffbase/gha-workflows/releases