PromucFlow_constructor/.github/workflows/build-docker-image.yml
Shrikant Sharat Kandula b442ca930e
ci: Include build information in Docker image labels (#39047)
## Description

Completion of https://github.com/appsmithorg/appsmith/pull/39025.

We're able to see the labels with Docker API (script written by Cursor):


![shot-2025-02-06-04-41-44](https://github.com/user-attachments/assets/2523b85c-cd2c-4481-ac08-2de76a0dc979)


Implemented by these two Cursor prompts 🙂


![shot-2025-02-06-05-16-29](https://github.com/user-attachments/assets/6787e5f4-161e-41c6-b6fb-bdec4ea92b38)


![shot-2025-02-06-05-16-43](https://github.com/user-attachments/assets/1ec3d449-0dff-44b0-9b39-487ef6514eea)


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Docker image builds now include added metadata (commit revision,
source, and version details) to improve image traceability and version
tracking.
  
- **Chores**
- CI workflows have been streamlined to consistently generate and apply
metadata labels, ensuring reliable and automated image processing across
all pipelines.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-02-06 11:22:19 +05:30

130 lines
4.5 KiB
YAML

name: Appsmith Build Docker Image Workflow
on:
# This line enables manual triggering of this workflow.
workflow_dispatch:
workflow_call:
inputs:
pr:
description: "This is the PR number in case the workflow is being called in a pull request"
required: false
type: number
jobs:
build-docker:
runs-on: ubuntu-latest
if: |
github.event.pull_request.head.repo.full_name == github.repository ||
github.event_name == 'push' ||
github.event_name == 'workflow_dispatch' ||
github.event_name == 'repository_dispatch' ||
github.event_name == 'schedule'
defaults:
run:
shell: bash
steps:
# Check out merge commit
- name: Fork based /ok-to-test checkout
if: inputs.pr != 0
uses: actions/checkout@v4
with:
ref: "refs/pull/${{ inputs.pr }}/merge"
# Checkout the code in the current branch in case the workflow is called because of a branch push event
- name: Checkout the head commit of the branch
if: inputs.pr == 0
uses: actions/checkout@v4
- name: Download the client build artifact
if: steps.run_result.outputs.run_result != 'success'
uses: actions/download-artifact@v4
with:
name: client-build
path: app/client
- name: Unpack the client build artifact
if: steps.run_result.outputs.run_result != 'success'
run: |
mkdir -p app/client/build
tar -xvf app/client/build.tar -C app/client/build
- name: Download the server build artifact
if: steps.run_result.outputs.run_result != 'success'
uses: actions/download-artifact@v4
with:
name: server-build
path: app/server/dist/
- name: Download the rts build artifact
if: steps.run_result.outputs.run_result != 'success'
uses: actions/download-artifact@v4
with:
name: rts-dist
path: app/client/packages/rts/dist
- name: Un-tar the rts folder
run: |
tar -xvf app/client/packages/rts/dist/rts-dist.tar -C app/client/packages/rts/
echo "Cleaning up the tar files"
rm app/client/packages/rts/dist/rts-dist.tar
- name: Generate info.json
id: info_json
run: |
scripts/generate_info_json.sh
- name: Place server artifacts-es
env:
EDITION: ${{ vars.EDITION }}
run: |
scripts/prepare_server_artifacts.sh
- name: Set base image tag
id: set_base_tag
run: |
if [[ "${{ inputs.pr }}" != 0 || "${{ github.ref_name }}" != master ]]; then
base_tag=release
else
base_tag=nightly
fi
echo "base_tag=$base_tag" >> $GITHUB_OUTPUT
# We don't use Depot Docker builds because it's faster for local Docker images to be built locally.
# It's slower and more expensive to build these Docker images on Depot and download it back to the CI node.
- name: Build docker image
if: steps.run_result.outputs.run_result != 'success'
working-directory: "."
run: |
set -o xtrace
declare -a args
base_tag=${{ steps.set_base_tag.outputs.base_tag }}
if [[ base_tag != 'nightly' ]]; then
args+=(--build-arg "APPSMITH_CLOUD_SERVICES_BASE_URL=https://release-cs.appsmith.com")
fi
args+=(--build-arg "BASE=${{ vars.DOCKER_HUB_ORGANIZATION }}/base-${{ vars.EDITION }}:$base_tag")
args+=(--label "org.opencontainers.image.revision=${{ steps.info_json.outputs.commitSha }}")
args+=(--label "org.opencontainers.image.source=${{ steps.info_json.outputs.repo }}")
args+=(--label "org.opencontainers.image.version=${{ steps.info_json.outputs.version }}")
docker build -t cicontainer "${args[@]}" .
# Saving the docker image to tar file
- name: Save Docker image to tar file
run: |
docker image ls --all --no-trunc --format '{{.Repository}},{{.ID}}' \
| grep -v cicontainer \
| cut -d, -f2 \
| xargs -r docker rmi || true
docker save cicontainer -o cicontainer.tar
gzip cicontainer.tar
- name: Cache docker image
uses: actions/cache/save@v4
with:
path: cicontainer.tar.gz
key: docker-image-${{github.run_id}}
- name: Save the status of the run
run: echo "run_result=success" >> $GITHUB_OUTPUT > ~/run_result