Doc-Gen/.github/workflows/docker-dev.yml at main · devalltect00/Doc-Gen · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# .github/workflows/docker-dev.yml

name: 🐋 Docker Development Image

run-name: 🐋 Dev Docker Build • ${{ github.ref_name }}

# =========================================================
# 🐋 Development Docker Image
# ---------------------------------------------------------
# Trigger:
# - Runs on push to `develop`
# - Can also be triggered manually
#
# Purpose:
# - Build and publish a development Docker image
#
# Published Tags:
# - `:dev`
#     Latest development image
#
# - `:sha-<commit>`
#     Immutable image for debugging and rollback
#
# Docker Target:
# - Uses the `development` stage from the multi-stage
#   Dockerfile
#
# Why SHA Tags?
# - Exact build reproducibility
# - Easier debugging
# - Safer rollback strategy
# - CI/CD traceability
#
# Registry:
# - GitHub Container Registry (GHCR)
#
# Example Images:
# - ghcr.io/<owner>/<repository>:dev
# - ghcr.io/<owner>/<repository>:sha-abc123
# =========================================================

on:
  push:
    branches:
      - develop
      - dev

  workflow_dispatch:

permissions:
  contents: read
  packages: write

env:
  REGISTRY: ghcr.io

jobs:
  docker-dev:
    name: 🐳 Build Dev Image
    runs-on: ubuntu-latest

    steps:
      # =====================================================
      # 📥 CHECKOUT
      # =====================================================

      # 📥 Checkout repository
      - name: 📥 Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: 🐍 Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.14"

      - name: 🔖 Resolve package version
        id: package-version
        shell: bash
        run: |
          python -m pip install --disable-pip-version-check packaging
          version="$(PYTHONPATH=app python -m doc_gen.core.build.version)"

          if [[ -z "$version" ]]; then
            echo "Build version resolution returned an empty value." >&2
            exit 1
          fi

          echo "value=$version" >> "$GITHUB_OUTPUT"

      # =====================================================
      # 🐳 DOCKER BUILDX
      # =====================================================

      - name: 🐳 Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      # =====================================================
      # 🔐 LOGIN TO GHCR
      # =====================================================

      # 🔐 Login to GitHub Container Registry
      - name: 🔐 Login to GHCR
        uses: docker/login-action@v3
        with:
          registry: ${{ env.REGISTRY }}
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      # =====================================================
      # 🏷️ IMAGE METADATA
      # =====================================================

      - name: 🔤 Normalize image name
        id: vars
        shell: bash
        run: |
          echo "image_name=${GITHUB_REPOSITORY,,}" >> "$GITHUB_OUTPUT"

      - name: 🏷️ Extract Docker metadata
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: |
            ghcr.io/${{ steps.vars.outputs.image_name }}

          tags: |
            type=raw,value=dev
            type=sha

      # =====================================================
      # 🏗️ BUILD AND PUSH
      # =====================================================

      - name: 🏗️ Build & push development image
        uses: docker/build-push-action@v6
        with:
          context: .

          file: Dockerfile

          target: development

          build-args: |
            DOC_GEN_BUILD_VERSION=${{ steps.package-version.outputs.value }}

          push: true

          tags: ${{ steps.meta.outputs.tags }}

          labels: ${{ steps.meta.outputs.labels }}

          cache-from: type=gha
          cache-to: type=gha,mode=max