Skip to content

[CU-86ev55tr6] Improve the Docker relative processes in the CD workflows #25

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.

Sign up for GitHub

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

Merged
Chisanan232 merged 3 commits into from
Oct 14, 2025
Merged

[CU-86ev55tr6] Improve the Docker relative processes in the CD workflows #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f608fc6
✏️ [release validation] Add a checking process of the project has Doc…
Chisanan232 Oct 14, 2025
ec7e813
✏️ [release staged] Add a checking process of the project has Dockerf…
Chisanan232 Oct 14, 2025
3815c6b
✏️ [release prod] Add a checking process of the project has Dockerfil…
Chisanan232 Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 25 additions & 5 deletions .github/workflows/rw_release_complete.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ on:
value: ${{ jobs.intent.outputs.python != 'skip' && jobs.intent.outputs.do_release == 'true' }}
docker_released:
description: 'Whether Docker images were released'
value: ${{ jobs.intent.outputs.docker != 'skip' && jobs.intent.outputs.do_release == 'true' }}
value: ${{ jobs.check-dockerfile.outputs.has_dockerfile == 'true' && jobs.intent.outputs.docker != 'skip' && jobs.intent.outputs.do_release == 'true' }}
docs_released:
description: 'Whether documentation was versioned'
value: ${{ jobs.prepare_docs_matrix.outputs.has_sections == 'true' && jobs.intent.outputs.do_release == 'true' }}
Expand All @@ -71,6 +71,26 @@ jobs:
name: Parse Configuration
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_parse_project_config.yaml@master

check-dockerfile:
name: Check Dockerfile Exists
runs-on: ubuntu-latest
outputs:
has_dockerfile: ${{ steps.check.outputs.has_dockerfile }}
steps:
- name: Checkout repository
uses: actions/checkout@v5

- name: Check for Dockerfile
id: check
run: |
if [ -f "Dockerfile" ]; then
echo "✅ Dockerfile found"
echo "has_dockerfile=true" >> $GITHUB_OUTPUT
else
echo "⚠️ No Dockerfile found - Docker processes will be skipped"
echo "has_dockerfile=false" >> $GITHUB_OUTPUT
fi

intent:
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_parse_release_intent.yaml@master
needs: config
Expand Down Expand Up @@ -376,8 +396,8 @@ jobs:
release_docker_hub:
name: Release to DockerHub
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docker_operations.yaml@master
needs: [config, intent, bump_version, build_git-tag_and_create_github-release]
if: needs.intent.outputs.do_release == 'true' && needs.intent.outputs.docker != 'skip'
needs: [config, check-dockerfile, intent, bump_version, build_git-tag_and_create_github-release]
if: needs.check-dockerfile.outputs.has_dockerfile == 'true' && needs.intent.outputs.do_release == 'true' && needs.intent.outputs.docker != 'skip'
secrets:
dockerhub-user: ${{ secrets.DOCKERHUB_USERNAME }}
registry-token: ${{ secrets.DOCKERHUB_TOKEN }}
Expand All @@ -393,8 +413,8 @@ jobs:
release_docker_ghcr:
name: Release to GHCR
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docker_operations.yaml@master
needs: [config, intent, bump_version, build_git-tag_and_create_github-release]
if: needs.intent.outputs.do_release == 'true' && needs.intent.outputs.docker != 'skip'
needs: [config, check-dockerfile, intent, bump_version, build_git-tag_and_create_github-release]
if: needs.check-dockerfile.outputs.has_dockerfile == 'true' && needs.intent.outputs.do_release == 'true' && needs.intent.outputs.docker != 'skip'
with:
operation: 'push'
registry: ${{ needs.config.outputs.docker_registry_ghcr }}
Expand Down
114 changes: 90 additions & 24 deletions .github/workflows/rw_release_staging_complete.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,26 @@ jobs:
name: Parse Configuration
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_parse_project_config.yaml@master

check-dockerfile:
name: Check Dockerfile Exists
runs-on: ubuntu-latest
outputs:
has_dockerfile: ${{ steps.check.outputs.has_dockerfile }}
steps:
- name: Checkout repository
uses: actions/checkout@v5

- name: Check for Dockerfile
id: check
run: |
if [ -f "Dockerfile" ]; then
echo "✅ Dockerfile found"
echo "has_dockerfile=true" >> $GITHUB_OUTPUT
else
echo "⚠️ No Dockerfile found - Docker processes will be skipped"
echo "has_dockerfile=false" >> $GITHUB_OUTPUT
fi

compute-version:
name: Compute Staging Version
runs-on: ubuntu-latest
Expand Down Expand Up @@ -118,7 +138,8 @@ jobs:
dockerhub-rc:
name: Staging Release to DockerHub
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docker_operations.yaml@master
needs: [config, compute-version, build_git-tag_and_create_github-release]
needs: [config, check-dockerfile, compute-version, build_git-tag_and_create_github-release]
if: needs.check-dockerfile.outputs.has_dockerfile == 'true'
secrets:
dockerhub-user: ${{ secrets.DOCKERHUB_USERNAME }}
registry-token: ${{ secrets.DOCKERHUB_TOKEN }}
Expand All @@ -136,7 +157,8 @@ jobs:
ghcr-rc:
name: Staging Release to GHCR
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docker_operations.yaml@master
needs: [config, compute-version, build_git-tag_and_create_github-release]
needs: [config, check-dockerfile, compute-version, build_git-tag_and_create_github-release]
if: needs.check-dockerfile.outputs.has_dockerfile == 'true'
with:
operation: 'push'
registry: ${{ needs.config.outputs.docker_registry_ghcr }}
Expand All @@ -161,7 +183,7 @@ jobs:
staging-summary:
name: Staging Release Summary
runs-on: ubuntu-latest
needs: [config, compute-version, pypi-test, ghcr-rc, docs-preview]
needs: [config, check-dockerfile, compute-version, pypi-test, dockerhub-rc, ghcr-rc, docs-preview]
if: always()
outputs:
success: ${{ steps.summary.outputs.success }}
Expand All @@ -171,37 +193,81 @@ jobs:
run: |
echo "=== Staging Release Summary ==="
echo ""
echo "Dockerfile Check: ${{ needs.check-dockerfile.outputs.has_dockerfile == 'true' && '✅ Found' || '⚠️ Not Found (Docker skipped)' }}"
echo "Version Computation: ${{ needs.compute-version.result }}"
echo "TestPyPI Upload: ${{ needs.pypi-test.result }}"
echo "GHCR RC Image: ${{ needs.ghcr-rc.result }}"

# Check if Docker processes were run
HAS_DOCKERFILE="${{ needs.check-dockerfile.outputs.has_dockerfile }}"
if [ "$HAS_DOCKERFILE" = "true" ]; then
echo "DockerHub RC Image: ${{ needs.dockerhub-rc.result }}"
echo "GHCR RC Image: ${{ needs.ghcr-rc.result }}"
else
echo "DockerHub RC Image: ⏭️ Skipped (no Dockerfile)"
echo "GHCR RC Image: ⏭️ Skipped (no Dockerfile)"
fi

echo "Docs Preview: ${{ needs.docs-preview.result }}"
echo ""
echo "📦 Staging Artifacts:"
echo "- Base Version: ${{ needs.compute-version.outputs.version }}"
echo "- RC Version: ${{ needs.compute-version.outputs.rc_version }}"
echo "- TestPyPI: https://test.pypi.org/project/${{ needs.config.outputs.project_name }}/${{ needs.compute-version.outputs.version }}/"
echo "- GHCR RC Image: ghcr.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"

if [ "$HAS_DOCKERFILE" = "true" ]; then
echo "- DockerHub RC Image: docker.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
echo "- GHCR RC Image: ghcr.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
fi

echo "- Docs Preview: docs-preview branch"
echo ""

if [[ "${{ needs.compute-version.result }}" == "success" && \
"${{ needs.pypi-test.result }}" == "success" && \
"${{ needs.ghcr-rc.result }}" == "success" && \
"${{ needs.docs-preview.result }}" == "success" ]]; then
echo "✅ Staging release completed successfully!"
echo "success=true" >> $GITHUB_OUTPUT
echo ""
echo "🧪 Testing Instructions:"
echo "1. Install from TestPyPI:"
echo " pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ ${{ needs.config.outputs.project_name }}==${{ needs.compute-version.outputs.version }}"
echo ""
echo "2. Test RC Docker image:"
echo " docker run -p ${{ needs.config.outputs.docker_health_check_port }}:${{ needs.config.outputs.docker_health_check_port }} ${{ needs.config.outputs.docker_run_options }} ghcr.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
echo ""
echo "3. Review documentation preview in docs-preview branch"
echo ""
# Validate results based on whether Docker processes were expected
VERSION_OK="${{ needs.compute-version.result == 'success' }}"
PYPI_OK="${{ needs.pypi-test.result == 'success' }}"
DOCS_OK="${{ needs.docs-preview.result == 'success' }}"

if [ "$HAS_DOCKERFILE" = "true" ]; then
# Docker processes should have run - validate them
DOCKERHUB_OK="${{ needs.dockerhub-rc.result == 'success' }}"
GHCR_OK="${{ needs.ghcr-rc.result == 'success' }}"

if [[ "$VERSION_OK" == "true" && "$PYPI_OK" == "true" && \
"$DOCKERHUB_OK" == "true" && "$GHCR_OK" == "true" && "$DOCS_OK" == "true" ]]; then
echo "✅ Staging release completed successfully!"
echo "success=true" >> $GITHUB_OUTPUT
echo ""
echo "🧪 Testing Instructions:"
echo "1. Install from TestPyPI:"
echo " pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ ${{ needs.config.outputs.project_name }}==${{ needs.compute-version.outputs.version }}"
echo ""
echo "2. Test RC Docker images:"
echo " docker run -p ${{ needs.config.outputs.docker_health_check_port }}:${{ needs.config.outputs.docker_health_check_port }} ${{ needs.config.outputs.docker_run_options }} ghcr.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
echo " docker run -p ${{ needs.config.outputs.docker_health_check_port }}:${{ needs.config.outputs.docker_health_check_port }} ${{ needs.config.outputs.docker_run_options }} docker.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
echo ""
echo "3. Review documentation preview in docs-preview branch"
echo ""
else
echo "❌ Some staging deployment steps failed. Check the logs above."
echo "success=false" >> $GITHUB_OUTPUT
exit 1
fi
else
echo "❌ Some staging deployment steps failed. Check the logs above."
echo "success=false" >> $GITHUB_OUTPUT
exit 1
# No Docker processes - only validate non-Docker components
if [[ "$VERSION_OK" == "true" && "$PYPI_OK" == "true" && "$DOCS_OK" == "true" ]]; then
echo "✅ Staging release completed successfully!"
echo "⚠️ Note: Docker builds were skipped (no Dockerfile found)"
echo "success=true" >> $GITHUB_OUTPUT
echo ""
echo "🧪 Testing Instructions:"
echo "1. Install from TestPyPI:"
echo " pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ ${{ needs.config.outputs.project_name }}==${{ needs.compute-version.outputs.version }}"
echo ""
echo "2. Review documentation preview in docs-preview branch"
echo ""
else
echo "❌ Some staging deployment steps failed. Check the logs above."
echo "success=false" >> $GITHUB_OUTPUT
exit 1
fi
fi
Loading