Add steps to check tag/branch patterns in CD

ecmwf-actions · Aug 26, 2024 · 48e977f · 48e977f
1 parent c8758fd
commit 48e977f
Show file tree

Hide file tree

Showing 3 changed files with 115 additions and 39 deletions.
diff --git a/.github/workflows/cd-module.yml b/.github/workflows/cd-module.yml
@@ -17,6 +17,31 @@ jobs:
     outputs:
       matrix: ${{ steps.matrix.outputs.matrix }}
     steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: "0"
+
+      - name: Test tag name pattern
+        shell: python
+        run: |
+          import re
+          import sys
+
+          tag_pattern = r"${{ vars.TAG_REGEX_FOR_DEPLOYMENT }}"
+          ref = "${{ github.ref_name }}"
+
+          if not tag_pattern:
+            sys.exit(0)
+
+          if not re.match(tag_pattern, ref):
+            print(f"::error::{ref} does not match {tag_pattern}")
+            sys.exit(1)
+
+      - name: Test branch name pattern
+        if: ${{ vars.BRANCH_REGEX_FOR_DEPLOYMENT != '' }}
+        run: |
+          git branch --all --list --format "%(refname:lstrip=-1)" --contains "${{ github.ref_name }}" | grep -E "${{ vars.BRANCH_REGEX_FOR_DEPLOYMENT }}"
+
       - name: Setup Matrix
         id: matrix
         shell: python

diff --git a/.github/workflows/cd-pypi.yml b/.github/workflows/cd-pypi.yml
@@ -5,8 +5,7 @@ on:
   workflow_call:
     inputs:
       testpypi:
-        description:
-          Whether to upload to testpypi instead of pypi.
+        description: Whether to upload to testpypi instead of pypi.
           Requires secrets.PYPI_TEST_API_TOKEN to be defined.
         type: boolean
         required: false
@@ -17,40 +16,63 @@ jobs:
     if: ${{ github.ref_type == 'tag' || github.event_name == 'release' }}
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.x"
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine build
-
-    - name: Check version
-      run: |
-        if [ -f "setup.py" ]; then
-          release=${{ github.ref_name }}
-          version=$(python setup.py --version)
-          test "$release" == "$version"
-        fi
-
-    - name: Build and publish to pypi
-      if: ${{ !inputs.testpypi }}
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-      run: |
-        python -m build
-        twine upload dist/*
-
-    - name: Build and publish to testpypi
-      if: ${{ inputs.testpypi }}
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_TEST_API_TOKEN }}
-      run: |
-        python -m build
-        twine upload --repository testpypi dist/*
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: "0"
+
+      - name: Test tag name pattern
+        shell: python
+        run: |
+          import re
+          import sys
+
+          tag_pattern = r"${{ vars.TAG_REGEX_FOR_DEPLOYMENT }}"
+          ref = "${{ github.ref_name }}"
+
+          if not tag_pattern:
+            sys.exit(0)
+
+          if not re.match(tag_pattern, ref):
+            print(f"::error::{ref} does not match {tag_pattern}")
+            sys.exit(1)
+
+      - name: Test branch name pattern
+        if: ${{ vars.BRANCH_REGEX_FOR_DEPLOYMENT != '' }}
+        run: |
+          git branch --all --list --format "%(refname:lstrip=-1)" --contains "${{ github.ref_name }}" | grep -E "${{ vars.BRANCH_REGEX_FOR_DEPLOYMENT }}"
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine build
+
+      - name: Check version
+        run: |
+          if [ -f "setup.py" ]; then
+            release=${{ github.ref_name }}
+            version=$(python setup.py --version)
+            test "$release" == "$version"
+          fi
+
+      - name: Build and publish to pypi
+        if: ${{ !inputs.testpypi }}
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python -m build
+          twine upload dist/*
+
+      - name: Build and publish to testpypi
+        if: ${{ inputs.testpypi }}
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TEST_API_TOKEN }}
+        run: |
+          python -m build
+          twine upload --repository testpypi dist/*
diff --git a/.github/workflows/create-package.yml b/.github/workflows/create-package.yml
@@ -40,8 +40,37 @@ on:
         required: false
 
 jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: "0"
+
+      - name: Test tag name pattern
+        shell: python
+        run: |
+          import re
+          import sys
+
+          tag_pattern = r"${{ vars.TAG_REGEX_FOR_DEPLOYMENT }}"
+          ref = "${{ github.ref_name }}"
+
+          if not tag_pattern:
+            sys.exit(0)
+
+          if not re.match(tag_pattern, ref):
+            print(f"::error::{ref} does not match {tag_pattern}")
+            sys.exit(1)
+
+      - name: Test branch name pattern
+        if: ${{ vars.BRANCH_REGEX_FOR_DEPLOYMENT != '' }}
+        run: |
+          git branch --all --list --format "%(refname:lstrip=-1)" --contains "${{ github.ref_name }}" | grep -E "${{ vars.BRANCH_REGEX_FOR_DEPLOYMENT }}"
+
   deploy:
     if: ${{ github.ref_type == 'tag' || inputs.skip_checks }}
+    needs: [check]
     strategy:
       fail-fast: false
       matrix: