From da8af2700f7a906e001a5ffb15ba3001cf9a2cf3 Mon Sep 17 00:00:00 2001 From: Ryan Inch Date: Wed, 4 Dec 2024 03:47:45 -0500 Subject: [PATCH 1/2] Add GitHub workflow file to build/tag/push custom docker images This allows docker images with a custom tag/name to be created on demand for any branch containing this workflow and pushed to the specified docker repository. Two versions of the docker image will always be pushed, one ending with -latest and one ending with the workflow run number, e.g. my-custom-image-name-latest and my-custom-image-name-42. The details required for the workflow to run can either be provided by predefined repository secrets/variables or specified manually when invoking the workflow. This should help make it easier to customize Community Edition instances, test pull requests/development branches, and to provide docker images of long running branches (large alpha/beta features) for community testing. --- .../workflows/custom-docker-build-push.yml | 129 ++++++++++++++++++ 1 file changed, 129 insertions(+) create mode 100644 .github/workflows/custom-docker-build-push.yml diff --git a/.github/workflows/custom-docker-build-push.yml b/.github/workflows/custom-docker-build-push.yml new file mode 100644 index 0000000000..f040a3ea80 --- /dev/null +++ b/.github/workflows/custom-docker-build-push.yml @@ -0,0 +1,129 @@ +# Based on the workflow by Brandon Patterson from https://github.com/mikemorran/hubs/blob/master/.github/workflows/ce-build.yml +# Input masking referenced from https://dev.to/leading-edje/masking-input-parameters-in-github-actions-1ci + +# Common registry base URLs: +# Docker Hub: docker.io +# GitHub: ghcr.io + +name: custom-docker-build-push + +on: + workflow_dispatch: + inputs: + Override_Registry_Base_URL: + type: string + Override_Registry_Username: + type: string + Override_Registry_Password: + type: string + Override_Registry_Namespace: + type: string + Override_Image_Tag: + type: string + Override_Dockerfile: + type: string + Override_Code_Path: + type: string + Use_Build_Cache: + type: boolean + default: true + +# Add in default values for the inputs plus define any missing variables we need. +# Everything should take their values from env rather than inputs. +env: + Registry_Base_URL: ${{ inputs.Override_Registry_Base_URL || vars.REGISTRY_BASE_URL }} +# Registry_Username: This must be added in each job that needs it. +# Registry_Password: This must be added in each job that needs it. + Registry_Namespace: ${{ inputs.Override_Registry_Namespace || vars.REGISTRY_NAMESPACE }} + Image_Tag: ${{ inputs.Override_Image_Tag || github.ref_name }} + Dockerfile: ${{ inputs.Override_Dockerfile || 'RetPageOriginDockerfile' }} + Code_Path: ${{ inputs.Override_Code_Path }} + Use_Build_Cache: ${{ inputs.Use_Build_Cache }} +# repo_name: This must be added in each job that needs it. + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Assign username from secret + if: ${{ inputs.Override_Registry_Username == ''}} + run: | + echo "Registry_Username=${{ secrets.REGISTRY_USERNAME }}" >> "$GITHUB_ENV" + + - name: Assign username from input + if: ${{ inputs.Override_Registry_Username != ''}} + run: | + USERNAME=$(jq -r '.inputs.Override_Registry_Username' $GITHUB_EVENT_PATH) + echo ::add-mask::$USERNAME + echo Registry_Username=$USERNAME >> $GITHUB_ENV + + - name: Assign password from secret + if: ${{ inputs.Override_Registry_Password == ''}} + run: | + echo "Registry_Password=${{ secrets.REGISTRY_PASSWORD }}" >> "$GITHUB_ENV" + + - name: Assign password from input + if: ${{ inputs.Override_Registry_Password != ''}} + run: | + PASSWORD=$(jq -r '.inputs.Override_Registry_Password' $GITHUB_EVENT_PATH) + echo ::add-mask::$PASSWORD + echo Registry_Password=$PASSWORD >> $GITHUB_ENV + + - name: Add the repository name as an env variable + run: | + echo "repo_name=${GITHUB_REPOSITORY#*/}" >> "$GITHUB_ENV" + + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + with: + install: true + + - name: Login to container registry + uses: docker/login-action@v3 + with: + registry: ${{ env.Registry_Base_URL }} + username: ${{ env.Registry_Username }} + password: ${{ env.Registry_Password }} + + - name: Checkout repository + uses: actions/checkout@v2 + with: + path: "./repo" + + - name: Use Code_Path for multirepo + if: ${{ env.Code_Path != ''}} + run: | + mkdir ./_repo + cp -rf ./repo/${{ env.Code_Path }}/* ./_repo + rm -rf ./repo + mv ./_repo ./repo + ls ./repo + + - name: Docker Buildx setup + uses: docker/setup-buildx-action@v3 + with: + install: true + + - name: Docker Build and Push (with cache) + if: ${{ fromJSON(env.Use_Build_Cache) == true }} + uses: docker/build-push-action@v6 + with: + context: repo/ + file: repo/${{ env.Dockerfile }} + tags: ${{ env.Registry_Base_URL }}/${{ env.Registry_Namespace }}/${{ env.repo_name }}:${{ env.Image_Tag }}-latest,${{ env.Registry_Base_URL }}/${{ env.Registry_Namespace }}/${{ env.repo_name }}:${{ env.Image_Tag }}-${{ github.run_number }} + cache-from: type=registry,ref=${{ env.Registry_Base_URL }}/${{ env.Registry_Namespace }}/${{ env.repo_name }}:buildcache + cache-to: type=registry,ref=${{ env.Registry_Base_URL }}/${{ env.Registry_Namespace }}/${{ env.repo_name }}:buildcache,mode=max,image-manifest=true,oci-mediatypes=true + push: true + + - name: Docker Build and Push (no cache) + if: ${{ fromJSON(env.Use_Build_Cache) == false }} + uses: docker/build-push-action@v6 + with: + context: repo/ + file: repo/${{ env.Dockerfile }} + tags: ${{ env.Registry_Base_URL }}/${{ env.Registry_Namespace }}/${{ env.repo_name }}:${{ env.Image_Tag }}-latest,${{ env.Registry_Base_URL }}/${{ env.Registry_Namespace }}/${{ env.repo_name }}:${{ env.Image_Tag }}-${{ github.run_number }} + push: true From 50d7b59ce139a98047ae4df360d90dcdab28a641 Mon Sep 17 00:00:00 2001 From: Ryan Inch Date: Sun, 29 Dec 2024 02:22:58 -0500 Subject: [PATCH 2/2] Refactor the custom docker build/push GitHub workflow Remove duplicate steps. Reorganize the steps into discrete sections. Both the checkout and docker buildx setup steps were present in the workflow file twice and while this didn't cause any problems running the workflow file it was confusing, unneeded (the buildx step is like installing a dependency and can happen anytime before the docker build/push step, as for the checkout step, everything was configured to use the code from the second checkout step thus making the first unnecessary), and probably slowed down its execution slightly. Removing the duplicate steps and reorganizing the rest makes everything simpler and clearer. --- .../workflows/custom-docker-build-push.yml | 29 ++++++++----------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/.github/workflows/custom-docker-build-push.yml b/.github/workflows/custom-docker-build-push.yml index f040a3ea80..30156e0193 100644 --- a/.github/workflows/custom-docker-build-push.yml +++ b/.github/workflows/custom-docker-build-push.yml @@ -46,6 +46,7 @@ jobs: runs-on: ubuntu-latest steps: + # Env variables - name: Assign username from secret if: ${{ inputs.Override_Registry_Username == ''}} run: | @@ -74,23 +75,9 @@ jobs: run: | echo "repo_name=${GITHUB_REPOSITORY#*/}" >> "$GITHUB_ENV" - - name: Checkout code - uses: actions/checkout@v2 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 - with: - install: true - - - name: Login to container registry - uses: docker/login-action@v3 - with: - registry: ${{ env.Registry_Base_URL }} - username: ${{ env.Registry_Username }} - password: ${{ env.Registry_Password }} - + # Code - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: path: "./repo" @@ -103,11 +90,19 @@ jobs: mv ./_repo ./repo ls ./repo - - name: Docker Buildx setup + # Docker + - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 with: install: true + - name: Login to container registry + uses: docker/login-action@v3 + with: + registry: ${{ env.Registry_Base_URL }} + username: ${{ env.Registry_Username }} + password: ${{ env.Registry_Password }} + - name: Docker Build and Push (with cache) if: ${{ fromJSON(env.Use_Build_Cache) == true }} uses: docker/build-push-action@v6