Skip to content

Commit c801aac

Browse files
developerkunaldeveloperkunal
committed
feat: enhance README with Docker instructions
feat: Add docker-compose configuration for OpenMorph CLI and development environments feat: Create example CI/CD configuration for GitHub Actions and Jenkins feat: Implement GitLab CI/CD pipeline for OpenAPI transformation and deployment feat: Add health check and Docker setup validation scripts for OpenMorph feat: Introduce example OpenMorph configuration for CI/CD environments feat: Add health checks and Docker registry commands to Makefile and Dockerfiles feat: Add multi-platform Docker build and push commands, update Dockerfiles to accept target architecture fix: Pin alpine version to 3.22.1 for consistent builds Bump version to 0.7.0 (minor release) feat: Update Dockerfiles to copy only necessary source files for builds
1 parent f1d0ab8 commit c801aac

17 files changed

+2312
-194
lines changed

‎.dockerignore‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# .dockerignore
2+
# Docker build context exclusions for optimal build performance and security
3+
4+
# Git and version control
5+
.git/
6+
.github/
7+
.gitignore
8+
.gitattributes
9+
10+
# Build artifacts and binaries
11+
openmorph
12+
*.exe
13+
*.dll
14+
*.so
15+
*.dylib
16+
*.test
17+
*.out
18+
/bin/
19+
/build/
20+
/dist/
21+
22+
# Development and testing
23+
.vscode/
24+
.idea/
25+
*.swp
26+
*.swo
27+
*~
28+
.DS_Store
29+
Thumbs.db
30+
31+
# Go specific
32+
vendor/
33+
*.mod.backup
34+
*.sum.backup
35+
36+
# Documentation and examples
37+
*.md
38+
docs/
39+
examples/
40+
/templates/
41+
42+
# CI/CD and deployment
43+
.github/
44+
.gitlab-ci.yml
45+
.travis.yml
46+
.circleci/
47+
Jenkinsfile
48+
docker-compose*.yml
49+
*.dockerfile
50+
Dockerfile.*
51+
52+
# Logs and temporary files
53+
*.log
54+
*.tmp
55+
*.temp
56+
/tmp/
57+
/logs/
58+
59+
# Test files and coverage
60+
*_test.go
61+
*.coverage
62+
coverage.out
63+
*.prof
64+
65+
# Development scripts and tools
66+
scripts/
67+
tools/
68+
Makefile
69+
*.sh
70+
71+
# Package manager files (keep go.mod and go.sum)
72+
package*.json
73+
yarn.lock
74+
Pipfile*
75+
requirements*.txt
76+
77+
# Configuration files (exclude sensitive configs)
78+
.env*
79+
*.yaml.bak
80+
*.yml.bak
81+
*.json.bak
82+
config.local.*
83+
84+
# Release and distribution
85+
.goreleaser.yml
86+
.version
87+
VERSION*
88+
CHANGELOG*
89+
AUTO_RELEASE_GUIDE.md
90+
PRODUCTION_READINESS.md
91+
VERSION_MANAGEMENT.md

‎.github/workflows/release.yml‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
workflow_dispatch:
88
inputs:
99
version:
10-
description: 'Version to release (leave empty to use .version file)'
10+
description: "Version to release (leave empty to use .version file)"
1111
required: false
1212
type: string
1313

@@ -23,12 +23,22 @@ jobs:
2323
- uses: actions/checkout@v4
2424
with:
2525
fetch-depth: 0
26-
26+
2727
- name: Set up Go
2828
uses: actions/setup-go@v5
2929
with:
3030
go-version: "1.24"
31-
31+
32+
- name: Set up Docker Buildx
33+
uses: docker/setup-buildx-action@v3
34+
35+
- name: Log in to GitHub Container Registry
36+
uses: docker/login-action@v3
37+
with:
38+
registry: ghcr.io
39+
username: ${{ github.actor }}
40+
password: ${{ secrets.GITHUB_TOKEN }}
41+
3242
- name: Get version from file
3343
id: version
3444
run: |
@@ -41,7 +51,7 @@ jobs:
4151
fi
4252
echo "version=$VERSION" >> $GITHUB_OUTPUT
4353
echo "Using version: $VERSION"
44-
54+
4555
- name: Create tag if needed
4656
if: github.event_name == 'workflow_dispatch'
4757
run: |
@@ -50,7 +60,7 @@ jobs:
5060
git tag -a "$VERSION" -m "Release $VERSION"
5161
git push origin "$VERSION"
5262
fi
53-
63+
5464
- name: Run GoReleaser
5565
uses: goreleaser/goreleaser-action@v6
5666
with:

‎.goreleaser.yml‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,208 @@ release:
2828
owner: developerkunal
2929
name: OpenMorph
3030

31+
# Docker images
32+
dockers:
33+
- image_templates:
34+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-amd64"
35+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-amd64"
36+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-amd64"
37+
- "ghcr.io/developerkunal/openmorph:latest-amd64"
38+
dockerfile: Dockerfile
39+
use: buildx
40+
goos: linux
41+
goarch: amd64
42+
build_flag_templates:
43+
- "--pull"
44+
- "--platform=linux/amd64"
45+
- "--label=org.opencontainers.image.created={{.Date}}"
46+
- "--label=org.opencontainers.image.title={{.ProjectName}}"
47+
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
48+
- "--label=org.opencontainers.image.version={{.Version}}"
49+
- "--label=org.opencontainers.image.source={{.GitURL}}"
50+
- "--build-arg=VERSION={{.Version}}"
51+
- "--build-arg=TARGETARCH=amd64"
52+
extra_files:
53+
- go.mod
54+
- go.sum
55+
- main.go
56+
- cmd/
57+
- internal/
58+
- image_templates:
59+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-arm64"
60+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-arm64"
61+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-arm64"
62+
- "ghcr.io/developerkunal/openmorph:latest-arm64"
63+
dockerfile: Dockerfile
64+
use: buildx
65+
goos: linux
66+
goarch: arm64
67+
build_flag_templates:
68+
- "--pull"
69+
- "--platform=linux/arm64"
70+
- "--label=org.opencontainers.image.created={{.Date}}"
71+
- "--label=org.opencontainers.image.title={{.ProjectName}}"
72+
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
73+
- "--label=org.opencontainers.image.version={{.Version}}"
74+
- "--label=org.opencontainers.image.source={{.GitURL}}"
75+
- "--build-arg=VERSION={{.Version}}"
76+
- "--build-arg=TARGETARCH=arm64"
77+
extra_files:
78+
- go.mod
79+
- go.sum
80+
- main.go
81+
- cmd/
82+
- internal/
83+
- image_templates:
84+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-distroless"
85+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-distroless"
86+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-distroless"
87+
dockerfile: Dockerfile.distroless
88+
use: buildx
89+
goos: linux
90+
goarch: amd64
91+
build_flag_templates:
92+
- "--pull"
93+
- "--platform=linux/amd64"
94+
- "--label=org.opencontainers.image.created={{.Date}}"
95+
- "--label=org.opencontainers.image.title={{.ProjectName}}"
96+
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
97+
- "--label=org.opencontainers.image.version={{.Version}}"
98+
- "--label=org.opencontainers.image.source={{.GitURL}}"
99+
- "--build-arg=VERSION={{.Version}}"
100+
- "--build-arg=TARGETARCH=amd64"
101+
extra_files:
102+
- go.mod
103+
- go.sum
104+
- main.go
105+
- cmd/
106+
- internal/
107+
- image_templates:
108+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-distroless-arm64"
109+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-distroless-arm64"
110+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-distroless-arm64"
111+
dockerfile: Dockerfile.distroless
112+
use: buildx
113+
goos: linux
114+
goarch: arm64
115+
build_flag_templates:
116+
- "--pull"
117+
- "--platform=linux/arm64"
118+
- "--label=org.opencontainers.image.created={{.Date}}"
119+
- "--label=org.opencontainers.image.title={{.ProjectName}}"
120+
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
121+
- "--label=org.opencontainers.image.version={{.Version}}"
122+
- "--label=org.opencontainers.image.source={{.GitURL}}"
123+
- "--build-arg=VERSION={{.Version}}"
124+
- "--build-arg=TARGETARCH=arm64"
125+
extra_files:
126+
- go.mod
127+
- go.sum
128+
- main.go
129+
- cmd/
130+
- internal/
131+
132+
# Add dev variant Docker builds
133+
- image_templates:
134+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-dev-amd64"
135+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-dev-amd64"
136+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-dev-amd64"
137+
- "ghcr.io/developerkunal/openmorph:latest-dev-amd64"
138+
dockerfile: Dockerfile.dev
139+
use: buildx
140+
goos: linux
141+
goarch: amd64
142+
build_flag_templates:
143+
- "--pull"
144+
- "--platform=linux/amd64"
145+
- "--label=org.opencontainers.image.created={{.Date}}"
146+
- "--label=org.opencontainers.image.title={{.ProjectName}}"
147+
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
148+
- "--label=org.opencontainers.image.version={{.Version}}"
149+
- "--label=org.opencontainers.image.source={{.GitURL}}"
150+
- "--build-arg=VERSION={{.Version}}"
151+
- "--build-arg=TARGETARCH=amd64"
152+
extra_files:
153+
- go.mod
154+
- go.sum
155+
- main.go
156+
- cmd/
157+
- internal/
158+
- image_templates:
159+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-dev-arm64"
160+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-dev-arm64"
161+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-dev-arm64"
162+
- "ghcr.io/developerkunal/openmorph:latest-dev-arm64"
163+
dockerfile: Dockerfile.dev
164+
use: buildx
165+
goos: linux
166+
goarch: arm64
167+
build_flag_templates:
168+
- "--pull"
169+
- "--platform=linux/arm64"
170+
- "--label=org.opencontainers.image.created={{.Date}}"
171+
- "--label=org.opencontainers.image.title={{.ProjectName}}"
172+
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
173+
- "--label=org.opencontainers.image.version={{.Version}}"
174+
- "--label=org.opencontainers.image.source={{.GitURL}}"
175+
- "--build-arg=VERSION={{.Version}}"
176+
- "--build-arg=TARGETARCH=arm64"
177+
extra_files:
178+
- go.mod
179+
- go.sum
180+
- main.go
181+
- cmd/
182+
- internal/
183+
184+
# Docker manifests for multi-platform support
185+
docker_manifests:
186+
- name_template: "ghcr.io/developerkunal/openmorph:{{ .Tag }}"
187+
image_templates:
188+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-amd64"
189+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-arm64"
190+
- name_template: "ghcr.io/developerkunal/openmorph:v{{ .Major }}"
191+
image_templates:
192+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-amd64"
193+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-arm64"
194+
- name_template: "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}"
195+
image_templates:
196+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-amd64"
197+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-arm64"
198+
- name_template: "ghcr.io/developerkunal/openmorph:latest"
199+
image_templates:
200+
- "ghcr.io/developerkunal/openmorph:latest-amd64"
201+
- "ghcr.io/developerkunal/openmorph:latest-arm64"
202+
# Distroless multi-platform manifests
203+
- name_template: "ghcr.io/developerkunal/openmorph:{{ .Tag }}-distroless"
204+
image_templates:
205+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-distroless"
206+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-distroless-arm64"
207+
- name_template: "ghcr.io/developerkunal/openmorph:v{{ .Major }}-distroless"
208+
image_templates:
209+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-distroless"
210+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-distroless-arm64"
211+
- name_template: "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-distroless"
212+
image_templates:
213+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-distroless"
214+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-distroless-arm64"
215+
# Dev multi-platform manifests
216+
- name_template: "ghcr.io/developerkunal/openmorph:{{ .Tag }}-dev"
217+
image_templates:
218+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-dev-amd64"
219+
- "ghcr.io/developerkunal/openmorph:{{ .Tag }}-dev-arm64"
220+
- name_template: "ghcr.io/developerkunal/openmorph:v{{ .Major }}-dev"
221+
image_templates:
222+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-dev-amd64"
223+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}-dev-arm64"
224+
- name_template: "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-dev"
225+
image_templates:
226+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-dev-amd64"
227+
- "ghcr.io/developerkunal/openmorph:v{{ .Major }}.{{ .Minor }}-dev-arm64"
228+
- name_template: "ghcr.io/developerkunal/openmorph:latest-dev"
229+
image_templates:
230+
- "ghcr.io/developerkunal/openmorph:latest-dev-amd64"
231+
- "ghcr.io/developerkunal/openmorph:latest-dev-arm64"
232+
31233
# Homebrew tap
32234
brews:
33235
- name: openmorph

0 commit comments

Comments
 (0)