♻️ Extract the values maybe customized for each GitHub project as the common usages.

Chisanan232 · Chisanan232 · commit de52e7db0228 · 2025-09-21T20:40:10.000+08:00
diff --git a/.github/workflows/release-staging.yml b/.github/workflows/release-staging.yml
@@ -22,6 +22,25 @@ concurrency:
   group: release-staging-${{ github.ref_name }}
   cancel-in-progress: false
 
+env:
+  # Project Configuration
+  PROJECT_NAME: ${{ vars.PROJECT_NAME || github.event.repository.name }}
+  BASE_BRANCH: ${{ vars.BASE_BRANCH || 'master' }}
+  PACKAGE_NAME: ${{ vars.PACKAGE_NAME || github.event.repository.name }}
+
+  # Docker Configuration
+  DOCKER_HEALTH_CHECK_PORT: ${{ vars.DOCKER_HEALTH_CHECK_PORT || '8000' }}
+  DOCKER_HEALTH_CHECK_PATH: ${{ vars.DOCKER_HEALTH_CHECK_PATH || '/health' }}
+  DOCKER_REGISTRY_DOCKERHUB: ${{ vars.DOCKER_REGISTRY_DOCKERHUB || 'docker.io' }}
+  DOCKER_REGISTRY_GHCR: ${{ vars.DOCKER_REGISTRY_GHCR || 'ghcr.io' }}
+
+  # Application Configuration
+  APP_ENV_VAR_NAME: ${{ vars.APP_ENV_VAR_NAME || 'API_TOKEN' }}
+  APP_ENV_VAR_VALUE: ${{ vars.APP_ENV_VAR_VALUE || 'your_token' }}
+
+  # Documentation Configuration
+  DOCS_PREVIEW_BRANCH: ${{ vars.DOCS_PREVIEW_BRANCH || 'docs-preview' }}
+
 jobs:
   compute-version:
     name: Compute Staging Version
@@ -100,27 +119,31 @@ jobs:
       registry-token: ${{ secrets.DOCKERHUB_TOKEN }}
     with:
       operation: 'push'
-      registry: 'docker.io'
+      registry: ${{ env.DOCKER_REGISTRY_DOCKERHUB }}
       version: ${{ needs.compute-version.outputs.rc_version }}
       checkout-sha: ${{ github.sha }}
       enable-sbom: true
       enable-signing: true
-      health-check-port: '8000'
-      health-check-path: '/health'
+      health-check-port: ${{ env.DOCKER_HEALTH_CHECK_PORT }}
+      health-check-path: ${{ env.DOCKER_HEALTH_CHECK_PATH }}
+      app-env-var-name: ${{ env.APP_ENV_VAR_NAME }}
+      app-env-var-value: ${{ env.APP_ENV_VAR_VALUE }}
 
   ghcr-rc:
     name: Staging Release to GHCR
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docker_operations.yaml@master
     needs: [compute-version, build_git-tag_and_create_github-release]
     with:
       operation: 'push'
-      registry: 'ghcr.io'
+      registry: ${{ env.DOCKER_REGISTRY_GHCR }}
       version: ${{ needs.compute-version.outputs.rc_version }}
       checkout-sha: ${{ github.sha }}
       enable-sbom: true
       enable-signing: true
-      health-check-port: '8000'
-      health-check-path: '/health'
+      health-check-port: ${{ env.DOCKER_HEALTH_CHECK_PORT }}
+      health-check-path: ${{ env.DOCKER_HEALTH_CHECK_PATH }}
+      app-env-var-name: ${{ env.APP_ENV_VAR_NAME }}
+      app-env-var-value: ${{ env.APP_ENV_VAR_VALUE }}
 
   docs-preview:
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docs_operations.yaml@master
@@ -129,7 +152,7 @@ jobs:
       operation: 'deploy-preview'
       version: ${{ needs.compute-version.outputs.rc_version }}
       checkout-sha: ${{ github.sha }}
-      preview-branch: 'docs-preview'
+      preview-branch: ${{ env.DOCS_PREVIEW_BRANCH }}
       upload-artifacts: true
 
   staging-summary:
@@ -150,7 +173,7 @@ jobs:
           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/clickup-mcp-server/${{ needs.compute-version.outputs.version }}/"
+          echo "- TestPyPI: https://test.pypi.org/project/${{ env.PROJECT_NAME }}/${{ needs.compute-version.outputs.version }}/"
           echo "- GHCR RC Image: ghcr.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
           echo "- Docs Preview: docs-preview branch"
           echo ""
@@ -163,10 +186,10 @@ jobs:
             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/ clickup-mcp-server==${{ needs.compute-version.outputs.version }}"
+            echo "   pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ ${{ env.PROJECT_NAME }}==${{ needs.compute-version.outputs.version }}"
             echo ""
             echo "2. Test RC Docker image:"
-            echo "   docker run -p 8000:8000 -e CLICKUP_API_TOKEN=your_token ghcr.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
+            echo "   docker run -p ${{ env.DOCKER_HEALTH_CHECK_PORT }}:${{ env.DOCKER_HEALTH_CHECK_PORT }} -e ${{ env.APP_ENV_VAR_NAME }}=${{ env.APP_ENV_VAR_VALUE }} ghcr.io/${{ github.repository }}:${{ needs.compute-version.outputs.rc_version }}"
             echo ""
             echo "3. Review documentation preview in docs-preview branch"
             echo ""
diff --git a/.github/workflows/release-validate.yml b/.github/workflows/release-validate.yml
@@ -3,7 +3,7 @@ name: Release Validation (Dry Run)
 on:
   pull_request:
     branches:
-      - <your_base_branch>
+      - <your_base_branch>  # Replace with your main branch (e.g., master, main)
     paths:
       - .github/tag_and_release/**
       - pyproject.toml
@@ -35,6 +35,26 @@ concurrency:
   group: release-validate-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  # Project Configuration
+  PROJECT_NAME: ${{ vars.PROJECT_NAME || github.event.repository.name }}
+  BASE_BRANCH: ${{ vars.BASE_BRANCH || 'master' }}
+  PACKAGE_NAME: ${{ vars.PACKAGE_NAME || github.event.repository.name }}
+
+  # Docker Configuration
+  DOCKER_HEALTH_CHECK_PORT: ${{ vars.DOCKER_HEALTH_CHECK_PORT || '8000' }}
+  DOCKER_HEALTH_CHECK_PATH: ${{ vars.DOCKER_HEALTH_CHECK_PATH || '/health' }}
+  DOCKER_REGISTRY_DOCKERHUB: ${{ vars.DOCKER_REGISTRY_DOCKERHUB || 'docker.io' }}
+  DOCKER_REGISTRY_GHCR: ${{ vars.DOCKER_REGISTRY_GHCR || 'ghcr.io' }}
+
+  # Application Configuration
+  APP_ENV_VAR_NAME: ${{ vars.APP_ENV_VAR_NAME || 'API_TOKEN' }}
+  APP_ENV_VAR_VALUE: ${{ vars.APP_ENV_VAR_VALUE || 'test_token' }}
+
+  # Validation Configuration
+  VALIDATION_VERSION: ${{ vars.VALIDATION_VERSION || '1.0.0-validation' }}
+  VALIDATION_TEST_VERSION: ${{ vars.VALIDATION_TEST_VERSION || 'validation-test' }}
+
 jobs:
   intent-parse:
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_parse_release_intent.yaml@master
@@ -49,7 +69,7 @@ jobs:
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_build_git-tag_and_create_github-release_v2.yaml@master
     needs: intent-parse
     with:
-      version: "1.0.0-validation"  # Test version for validation
+      version: ${{ env.VALIDATION_VERSION }}  # Test version for validation
       debug_mode: true
     secrets:
       github_auth_token: ${{ secrets.GITHUB_TOKEN }}
@@ -67,25 +87,29 @@ jobs:
     needs: build_git-tag_and_create_github-release
     with:
       operation: 'test'
-      registry: 'docker.io'
+      registry: ${{ env.DOCKER_REGISTRY_DOCKERHUB }}
       image-name: ${{ github.repository }}
-      version: 'validation-test'
-      health-check-port: '8000'
-      health-check-path: '/health'
+      version: ${{ env.VALIDATION_TEST_VERSION }}
+      health-check-port: ${{ env.DOCKER_HEALTH_CHECK_PORT }}
+      health-check-path: ${{ env.DOCKER_HEALTH_CHECK_PATH }}
       enable-signing: true
+      app-env-var-name: ${{ env.APP_ENV_VAR_NAME }}
+      app-env-var-value: ${{ env.APP_ENV_VAR_VALUE }}
 
   docker-build-ghcr:
     name: Validate GHCR Build
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docker_operations.yaml@master
     needs: build_git-tag_and_create_github-release
     with:
       operation: 'test'
-      registry: 'ghcr.io'
+      registry: ${{ env.DOCKER_REGISTRY_GHCR }}
       image-name: ${{ github.repository }}
-      version: 'validation-test'
-      health-check-port: '8000'
-      health-check-path: '/health'
+      version: ${{ env.VALIDATION_TEST_VERSION }}
+      health-check-port: ${{ env.DOCKER_HEALTH_CHECK_PORT }}
+      health-check-path: ${{ env.DOCKER_HEALTH_CHECK_PATH }}
       enable-signing: true
+      app-env-var-name: ${{ env.APP_ENV_VAR_NAME }}
+      app-env-var-value: ${{ env.APP_ENV_VAR_VALUE }}
 
   docs-build:
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docs_operations.yaml@master
@@ -100,11 +124,13 @@ jobs:
     needs: [docker-build-dockerhub, docker-build-ghcr]
     with:
       operation: 'security-scan'
-      registry: 'docker.io'  # Use DockerHub build for security scan
+      registry: ${{ env.DOCKER_REGISTRY_DOCKERHUB }}  # Use DockerHub build for security scan
       image-name: ${{ github.repository }}
-      version: 'validation-test'
+      version: ${{ env.VALIDATION_TEST_VERSION }}
       enable-sbom: true
       enable-signing: true
+      app-env-var-name: ${{ env.APP_ENV_VAR_NAME }}
+      app-env-var-value: ${{ env.APP_ENV_VAR_VALUE }}
 
   validation-summary:
     name: Validation Summary
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,7 +4,7 @@ name: release
 on:
   push:
     branches:
-      - <your_base_branch>
+      - <your_base_branch>  # Replace with your main branch (e.g., master, main)
     paths:
       - .github/tag_and_release/release-**
   workflow_dispatch:
@@ -56,6 +56,32 @@ concurrency:
   group: release-${{ github.ref_name }}
   cancel-in-progress: false
 
+env:
+  # Project Configuration
+  PROJECT_NAME: ${{ vars.PROJECT_NAME || github.event.repository.name }}
+  BASE_BRANCH: ${{ vars.BASE_BRANCH || 'master' }}
+  PACKAGE_NAME: ${{ vars.PACKAGE_NAME || github.event.repository.name }}
+
+  # Git Configuration
+  GIT_COMMIT_EMAIL: ${{ vars.GIT_COMMIT_EMAIL || 'action@github.com' }}
+  GIT_COMMIT_NAME: ${{ vars.GIT_COMMIT_NAME || 'GitHub Action' }}
+
+  # Docker Configuration
+  DOCKER_HEALTH_CHECK_PORT: ${{ vars.DOCKER_HEALTH_CHECK_PORT || '8000' }}
+  DOCKER_HEALTH_CHECK_PATH: ${{ vars.DOCKER_HEALTH_CHECK_PATH || '/health' }}
+  DOCKER_REGISTRY_DOCKERHUB: ${{ vars.DOCKER_REGISTRY_DOCKERHUB || 'docker.io' }}
+  DOCKER_REGISTRY_GHCR: ${{ vars.DOCKER_REGISTRY_GHCR || 'ghcr.io' }}
+
+  # Application Configuration
+  APP_ENV_VAR_NAME: ${{ vars.APP_ENV_VAR_NAME || 'API_TOKEN' }}
+  APP_ENV_VAR_VALUE: ${{ vars.APP_ENV_VAR_VALUE || 'test_token' }}
+
+  # Documentation Configuration
+  DOCS_PREVIEW_BRANCH: ${{ vars.DOCS_PREVIEW_BRANCH || 'docs-preview' }}
+  DOCS_CI_CD_PATH: ${{ vars.DOCS_CI_CD_PATH || 'docs/contents/development/ci-cd.mdx' }}
+  DOCS_INSTALLATION_PATH: ${{ vars.DOCS_INSTALLATION_PATH || 'docs/contents/document/installation.md' }}
+  DOCS_README_PATH: ${{ vars.DOCS_README_PATH || 'docs/contents/document/README.md' }}
+
 jobs:
   intent:
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_parse_release_intent.yaml@master
@@ -213,8 +239,8 @@ jobs:
 
       - name: Configure git
         run: |
-          git config --global user.email "action@github.com"
-          git config --global user.name "GitHub Action"
+          git config --global user.email "${{ env.GIT_COMMIT_EMAIL }}"
+          git config --global user.name "${{ env.GIT_COMMIT_NAME }}"
 
       - name: Bump version with uv
         id: bump
@@ -251,31 +277,31 @@ jobs:
           DOCS_UPDATED=false
           
           # Update main CI/CD documentation if it exists
-          if [ -f "docs/contents/development/ci-cd.mdx" ]; then
+          if [ -f "${{ env.DOCS_CI_CD_PATH }}" ]; then
             # Update any version references in installation examples, if they exist
-            if grep -q "clickup-mcp-server" "docs/contents/development/ci-cd.mdx"; then
+            if grep -q "${{ env.PROJECT_NAME }}" "${{ env.DOCS_CI_CD_PATH }}"; then
               # This is just a placeholder - adjust pattern as needed for actual version references
               echo "Found version references in ci-cd.mdx to update"
               DOCS_UPDATED=true
             fi
           fi
           
           # Update package installation docs if they exist
-          if [ -f "docs/contents/document/installation.md" ]; then
-            if grep -q "pip install.*clickup-mcp-server" "docs/contents/document/installation.md"; then
-              sed -i.bak "s/clickup-mcp-server==[0-9]\+\.[0-9]\+\.[0-9]\+/clickup-mcp-server==$NEW_VERSION/g" "docs/contents/document/installation.md"
-              rm -f "docs/contents/document/installation.md.bak" 2>/dev/null || true
+          if [ -f "${{ env.DOCS_INSTALLATION_PATH }}" ]; then
+            if grep -q "pip install.*${{ env.PROJECT_NAME }}" "${{ env.DOCS_INSTALLATION_PATH }}"; then
+              sed -i.bak "s/${{ env.PROJECT_NAME }}==[0-9]\+\.[0-9]\+\.[0-9]\+/${{ env.PROJECT_NAME }}==$NEW_VERSION/g" "${{ env.DOCS_INSTALLATION_PATH }}"
+              rm -f "${{ env.DOCS_INSTALLATION_PATH }}.bak" 2>/dev/null || true
               echo "Updated installation documentation with new version"
               DOCS_UPDATED=true
             fi
           fi
           
           # Update README if it has version references
-          if [ -f "docs/contents/document/README.md" ]; then
-            if grep -q "clickup-mcp-server" "docs/contents/document/README.md"; then
+          if [ -f "${{ env.DOCS_README_PATH }}" ]; then
+            if grep -q "${{ env.PROJECT_NAME }}" "${{ env.DOCS_README_PATH }}"; then
               # Update version references in README examples
-              sed -i.bak "s/clickup-mcp-server==[0-9]\+\.[0-9]\+\.[0-9]\+/clickup-mcp-server==$NEW_VERSION/g" "docs/contents/document/README.md"
-              rm -f "docs/contents/document/README.md.bak" 2>/dev/null || true
+              sed -i.bak "s/${{ env.PROJECT_NAME }}==[0-9]\+\.[0-9]\+\.[0-9]\+/${{ env.PROJECT_NAME }}==$NEW_VERSION/g" "${{ env.DOCS_README_PATH }}"
+              rm -f "${{ env.DOCS_README_PATH }}.bak" 2>/dev/null || true
               echo "Updated README documentation with new version"
               DOCS_UPDATED=true
             fi
@@ -288,13 +314,13 @@ jobs:
           # Add documentation files if they were updated
           if [ "$DOCS_UPDATED" = true ]; then
             # Add any updated documentation files
-            if [ -f "docs/contents/document/installation.md" ]; then
-              git add "docs/contents/document/installation.md"
-              FILES_TO_COMMIT="$FILES_TO_COMMIT docs/contents/document/installation.md"
+            if [ -f "${{ env.DOCS_INSTALLATION_PATH }}" ]; then
+              git add "${{ env.DOCS_INSTALLATION_PATH }}"
+              FILES_TO_COMMIT="$FILES_TO_COMMIT ${{ env.DOCS_INSTALLATION_PATH }}"
             fi
-            if [ -f "docs/contents/document/README.md" ]; then
-              git add "docs/contents/document/README.md"  
-              FILES_TO_COMMIT="$FILES_TO_COMMIT docs/contents/document/README.md"
+            if [ -f "${{ env.DOCS_README_PATH }}" ]; then
+              git add "${{ env.DOCS_README_PATH }}"  
+              FILES_TO_COMMIT="$FILES_TO_COMMIT ${{ env.DOCS_README_PATH }}"
             fi
             COMMIT_MESSAGE="⬆️ chore: bump version to $NEW_VERSION, sync uv.lock, and update docs"
             echo "Documentation files updated and will trigger documentation workflow"
@@ -362,11 +388,13 @@ jobs:
       registry-token: ${{ secrets.DOCKERHUB_TOKEN }}
     with:
       operation: 'push'
-      registry: 'docker.io'
+      registry: ${{ env.DOCKER_REGISTRY_DOCKERHUB }}
       version: ${{ needs.bump_version.outputs.version }}
       checkout-sha: ${{ needs.bump_version.outputs.new_sha }}
       enable-sbom: true
       enable-signing: true
+      app-env-var-name: ${{ env.APP_ENV_VAR_NAME }}
+      app-env-var-value: ${{ env.APP_ENV_VAR_VALUE }}
 
   release_docker_ghcr:
     name: Release to GHCR
@@ -375,11 +403,13 @@ jobs:
     if: needs.intent.outputs.do_release == 'true' && needs.intent.outputs.docker != 'skip'
     with:
       operation: 'push'
-      registry: 'ghcr.io'
+      registry: ${{ env.DOCKER_REGISTRY_GHCR }}
       version: ${{ needs.bump_version.outputs.version }}
       checkout-sha: ${{ needs.bump_version.outputs.new_sha }}
       enable-sbom: true
       enable-signing: true
+      app-env-var-name: ${{ env.APP_ENV_VAR_NAME }}
+      app-env-var-value: ${{ env.APP_ENV_VAR_VALUE }}
 
   release_docs:
     uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_docs_operations.yaml@master
diff --git a/.github/workflows/rw_docker_operations.yaml b/.github/workflows/rw_docker_operations.yaml
@@ -58,6 +58,16 @@ on:
         required: false
         default: ''
         type: string
+      app-env-var-name:
+        description: 'Application environment variable name for testing'
+        required: false
+        default: 'API_TOKEN'
+        type: string
+      app-env-var-value:
+        description: 'Application environment variable value for testing'
+        required: false
+        default: 'test_token'
+        type: string
 
     secrets:
       dockerhub-user:
@@ -177,7 +187,7 @@ jobs:
           # Start container in background
           docker run -d --name test-container \
             -p ${{ inputs.health-check-port }}:${{ inputs.health-check-port }} \
-            -e CLICKUP_API_TOKEN=test_token \
+            -e ${{ inputs.app-env-var-name }}=${{ inputs.app-env-var-value }} \
             $IMAGE_TAG
           
           # Wait for container to be ready and test health endpoint
