-
Notifications
You must be signed in to change notification settings - Fork 3
ADD: GitHub Action - improved build workflow #78
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
derekclair
wants to merge
8
commits into
main
Choose a base branch
from
dc/improved-build-github-action
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
24b2bc0
build pipeline
derekclair bf3da7c
LFC: method for secure OIDC configuration
derekclair 59c15a8
Add QEMU setup
derekclair bfcb401
Update docker_build.yml
derekclair 692cc97
Update workflow: multi-job Docker builds with metadata, caching, prov…
derekclair 529e0f1
Merge branch 'main' into dc/improved-build-github-action
derekclair 1cef960
Update PROJECT_README.md
derekclair 1c83b0a
Merge branch 'dc/improved-build-github-action' of github.com:IQGeo/ut…
derekclair File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,243 @@ | ||
| name: Build & Push Docker Images | ||
| run-name: Build & Push ${{ github.base_ref || github.ref_name }} | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main, develop ] | ||
| pull_request: | ||
| branches: [ main ] | ||
| workflow_dispatch: | ||
| inputs: | ||
|
|
||
| platform_version: | ||
| description: 'platform version' | ||
| required: true | ||
| default: '7.3' | ||
|
|
||
| push_images: | ||
| description: 'Y/N push images to container registry' | ||
| type: boolean | ||
| default: true | ||
|
|
||
| permissions: | ||
| id-token: write | ||
| contents: read | ||
| env: | ||
| PLATFORM_VERSION: ${{ github.event.inputs.platform_version || '7.3' }} | ||
| DOCKER_BUILD_SUMMARY: true | ||
| DOCKER_BUILD_RECORD_UPLOAD: true | ||
|
|
||
| jobs: | ||
|
|
||
| build-build-image: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| image_name: ${{ vars.registry }}/${{ vars.repository }}/${{ vars.image_name }}-build | ||
| outputs: | ||
| digest: ${{ steps.build.outputs.digest }} | ||
| image-id: ${{ steps.build.outputs.imageid }} | ||
| metadata: ${{ steps.build.outputs.metadata }} | ||
| steps: | ||
| - | ||
| name: checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| lfs: true | ||
|
|
||
| ### `cloud-addon-modules` has been officially deprecated. | ||
| # - name: checkout `cloud-addon-modules` | ||
| # uses: actions/checkout@v4 | ||
| # with: | ||
| # repository: IQGeo/cloud-addon-modules | ||
| # path: cloud-addons | ||
| # token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT (personal access token) | ||
| # lfs: true | ||
|
|
||
| - | ||
| name: setup Docker BuildX | ||
| uses: docker/setup-buildx-action@v3 | ||
| - | ||
| name: login to Harbor Registry (for pulling base images) | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: ${{ vars.registry }} | ||
| username: ${{ vars.registry_username }} | ||
| password: ${{ secrets.registry_password }} | ||
|
|
||
| - | ||
| name: extract metadata for `build` image | ||
| id: meta-build | ||
| uses: docker/metadata-action@v5 | ||
| with: | ||
| images: ${{ env.image_name }} | ||
| tags: | | ||
| type=raw,value=${{ env.PLATFORM_VERSION }} | ||
| type=raw,value=${{ github.run_number }} | ||
| type=raw,value=${{ github.base_ref || github.ref_name }} | ||
| type=sha,prefix={{branch}}- | ||
|
|
||
| - | ||
| name: build and push `build` image | ||
| id: build | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| platforms: linux/amd64,linux/arm64 | ||
| context: . | ||
| file: ./deployment/dockerfile.build | ||
| pull: true | ||
| push: false | ||
| tags: ${{ steps.meta-build.outputs.tags }} | ||
| labels: ${{ steps.meta-build.outputs.labels }} | ||
| annotations: ${{ steps.meta-build.outputs.annotations }} | ||
| build-args: | | ||
| PRODUCT_REGISTRY=harbor.delivery.iqgeo.cloud/releases_ | ||
| cache-from: | | ||
| type=gha,scope=build-latest | ||
| type=gha,scope=build-${{ github.sha }} | ||
| type=registry,ref=${{ env.image_name }}:buildcache | ||
| cache-to: | | ||
| type=gha,scope=build-${{ github.sha }},mode=min | ||
| type=registry,ref=${{ env.image_name }}:buildcache,mode=min | ||
| provenance: mode=max | ||
| sbom: true | ||
|
|
||
| build-appserver-image: | ||
| needs: build-build-image | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| image_name: ${{ vars.registry }}/${{ vars.repository }}/${{ vars.image_name }}-appserver | ||
| outputs: | ||
| digest: ${{ steps.build.outputs.digest }} | ||
| image-id: ${{ steps.build.outputs.imageid }} | ||
| metadata: ${{ steps.build.outputs.metadata }} | ||
| steps: | ||
| - | ||
| name: checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| lfs: true | ||
| - | ||
| name: setup Docker BuildX | ||
| uses: docker/setup-buildx-action@v3 | ||
| - | ||
| name: login to Harbor Registry (for pulling base images) | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: ${{ vars.registry }} | ||
| username: ${{ vars.registry_username }} | ||
| password: ${{ secrets.registry_password }} | ||
| - | ||
| name: extract metadata for `appserver` image | ||
| id: meta-appserver | ||
| uses: docker/metadata-action@v5 | ||
| with: | ||
| images: ${{ env.image_name }} | ||
| tags: | | ||
| type=raw,value=${{ env.PLATFORM_VERSION }} | ||
| type=raw,value=${{ github.run_number }} | ||
| type=raw,value=${{ github.base_ref || github.ref_name }} | ||
| type=sha,prefix={{branch}}- | ||
| - | ||
| name: build and push `appserver` image | ||
| id: build | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| platforms: linux/amd64,linux/arm64 | ||
| context: ./deployment | ||
| file: ./deployment/dockerfile.appserver | ||
| pull: true | ||
| push: ${{ github.event.inputs.push_images != 'false' }} | ||
| tags: ${{ steps.meta-appserver.outputs.tags }} | ||
| labels: ${{ steps.meta-appserver.outputs.labels }} | ||
| annotations: ${{ steps.meta-appserver.outputs.annotations }} | ||
| build-args: | | ||
| PRODUCT_REGISTRY=harbor.delivery.iqgeo.cloud/releases_ | ||
| cache-from: | | ||
| type=gha,scope=appserver-latest | ||
| type=gha,scope=appserver-${{ github.sha }} | ||
| type=registry,ref=${{ env.image_name }}:buildcache | ||
| cache-to: | | ||
| type=gha,scope=appserver-${{ github.sha }},mode=min | ||
| type=registry,ref=${{ env.image_name }}:buildcache,mode=min | ||
| provenance: mode=max | ||
| sbom: true | ||
|
|
||
| build-tools-image: | ||
| needs: build-build-image | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| image_name: ${{ vars.registry }}/${{ vars.repository }}/${{ vars.image_name }}-tools | ||
| outputs: | ||
| digest: ${{ steps.build.outputs.digest }} | ||
| image-id: ${{ steps.build.outputs.imageid }} | ||
| metadata: ${{ steps.build.outputs.metadata }} | ||
| steps: | ||
| - | ||
| name: checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| lfs: true | ||
| - | ||
| name: setup Docker BuildX | ||
| uses: docker/setup-buildx-action@v3 | ||
| - | ||
| name: login to Harbor Registry (for pulling base images) | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: ${{ vars.registry }} | ||
| username: ${{ vars.registry_username }} | ||
| password: ${{ secrets.registry_password }} | ||
| - | ||
| name: extract metadata for `tools` image | ||
| id: meta-tools | ||
| uses: docker/metadata-action@v5 | ||
| env: | ||
| DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index | ||
| with: | ||
| images: ${{ env.image_name }} | ||
| tags: | | ||
| type=raw,value=${{ env.PLATFORM_VERSION }} | ||
| type=raw,value=${{ github.run_number }} | ||
| type=raw,value=${{ github.base_ref || github.ref_name }} | ||
| type=sha,prefix={{branch}}- | ||
| - | ||
| name: build and push `tools` image | ||
| id: build | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| platforms: linux/amd64,linux/arm64 | ||
| context: . | ||
| file: ./deployment/dockerfile.tools | ||
| pull: true | ||
| push: ${{ github.event.inputs.push_images != 'false' }} | ||
| tags: ${{ steps.meta-tools.outputs.tags }} | ||
| labels: ${{ steps.meta-tools.outputs.labels }} | ||
| annotations: ${{ steps.meta-tools.outputs.annotations }} | ||
| build-args: | | ||
| PRODUCT_REGISTRY=harbor.delivery.iqgeo.cloud/releases_ | ||
| cache-from: | | ||
| type=gha,scope=tools-latest | ||
| type=gha,scope=tools-${{ github.sha }} | ||
| type=registry,ref=${{ env.image_name }}:buildcache | ||
| cache-to: | | ||
| type=gha,scope=tools-${{ github.sha }},mode=min | ||
| type=registry,ref=${{ env.image_name }}:buildcache,mode=min | ||
| provenance: mode=max | ||
| sbom: true | ||
|
|
||
| cleanup: | ||
| if: always() | ||
| needs: | ||
| - build-build-image | ||
| - build-appserver-image | ||
| - build-tools-image | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: clean-up temporary artifacts | ||
| uses: geekyeggo/delete-artifact@v5 | ||
| with: | ||
| name: | | ||
| build-image-metadata | ||
| appserver-image-metadata | ||
| tools-image-metadata | ||
| if: always() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Guard against running on template repository
Since this is a template repository, consider adding a condition to prevent the workflow from running on the template repo itself. We could add this to the jobs:
This ensures the workflow only runs in repos created from this template, not on the template itself.
Alternatively, we could: