chore: add names to GitHub Actions (#595)

serious-scaffold · Jun 8, 2024 · 43843f9 · 43843f9
1 parent c61eb9e
commit 43843f9
Show file tree

Hide file tree

Showing 10 changed files with 138 additions and 86 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,10 +15,12 @@ jobs:
  if: ${{ !cancelled() && ! failure() }}
  runs-on: ${{ matrix.os }}
  steps:
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
  with:
  fetch-depth: 0
- - uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
+ - name: Set up PDM
+ uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
  with:
  cache: true
  python-version: ${{ matrix.python-version }}
@@ -59,7 +61,8 @@ jobs:
  runs-on: ubuntu-22.04
  steps:
  - run: env | sort
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
  - name: Set up Git
  run: |
  git config --global user.name github-actions
@@ -96,7 +99,8 @@ jobs:
  echo "# :warning: GITHUB_TOKEN is used for semantic-release" >> $GITHUB_STEP_SUMMARY
  echo "The GITHUB_TOKEN is used instead of a bot token or PAT and will not emit the released publish event for the released workflow." >> $GITHUB_STEP_SUMMARY
  fi
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
  with:
  fetch-depth: 0
  persist-credentials: false

diff --git a/.github/workflows/devcontainer.yml b/.github/workflows/devcontainer.yml
@@ -26,35 +26,43 @@ jobs:
  runs-on: ubuntu-22.04
  steps:
  - run: env | sort
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- - run: docker login -u ${{ github.actor }} -p ${{ secrets.GITHUB_TOKEN }} ghcr.io
- - run: |
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Set up authentication
+ run: docker login -u ${{ github.actor }} -p ${{ secrets.GITHUB_TOKEN }} ghcr.io
+ - name: Set up BuildKit
+ run: |
  docker context create builder
  docker buildx create builder --name container --driver docker-container --use
  docker buildx inspect --bootstrap --builder container
- - run: |
+ - name: Build the dev container
+ run: |
  docker buildx build . \
  --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
  --cache-from type=registry,ref=ghcr.io/${{ github.repository }}/dev-cache:py${{ matrix.python-version }} \
  --file .devcontainer/Dockerfile \
  --load \
  --tag ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }} \
  --target dev
- - run: |
+ - name: Test the dev container
+ run: |
  docker run --rm \
  -e CI=true \
  -v ${PWD}:/workspace \
  ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }} \
  make dev lint test doc build
- - run: |
+ - name: Build the prod container
+ run: |
  docker buildx build . \
  --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
  --file .devcontainer/Dockerfile \
  --load \
  --tag ghcr.io/${{ github.repository }}:py${{ matrix.python-version }} \
  --target prod
- - run: docker run --rm ghcr.io/${{ github.repository }}:py${{ matrix.python-version }}
- - if: github.event_name != 'pull_request'
+ - name: Test the prod container
+ run: docker run --rm ghcr.io/${{ github.repository }}:py${{ matrix.python-version }}
+ - name: Push the dev container
+ if: github.event_name != 'pull_request'
  run: |
  docker buildx build . \
  --build-arg PYTHON_VERSION=${{ matrix.python-version }} \

diff --git a/.github/workflows/readthedocs-preview.yml b/.github/workflows/readthedocs-preview.yml
@@ -6,7 +6,8 @@ jobs:
  documentation-links:
  runs-on: ubuntu-22.04
  steps:
- - uses: readthedocs/actions/preview@cc0920454cf03ca8a3fbd3cbaa2ce2e509e70636 # v1.2
+ - name: Add Read the Docs preview's link to pull request
+ uses: readthedocs/actions/preview@cc0920454cf03ca8a3fbd3cbaa2ce2e509e70636 # v1.2
  with:
  project-slug: ss-python
 on:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,10 +13,12 @@ jobs:
  pages-build:
  runs-on: ubuntu-22.04
  steps:
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
  with:
  fetch-depth: 0
- - uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
+ - name: Set up PDM
+ uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
  with:
  cache: true
  python-version: '3.12'
@@ -45,13 +47,17 @@ jobs:
  runs-on: ubuntu-22.04
  steps:
  - run: env | sort
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- - run: docker login -u ${{ github.actor }} -p ${{ secrets.GITHUB_TOKEN }} ghcr.io
- - run: |
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Set up authentication
+ run: docker login -u ${{ github.actor }} -p ${{ secrets.GITHUB_TOKEN }} ghcr.io
+ - name: Set up BuildKit
+ run: |
  docker context create builder
  docker buildx create builder --name container --driver docker-container --use
  docker buildx inspect --bootstrap --builder container
- - run: |
+ - name: Build the dev container
+ run: |
  docker buildx build . \
  --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
  --cache-from type=registry,ref=ghcr.io/${{ github.repository }}/dev-cache:py${{ matrix.python-version }} \
@@ -60,22 +66,15 @@ jobs:
  --tag ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }} \
  --tag ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }}-${{ github.ref_name }} \
  --target dev
- - run: |
+ - name: Test the dev container
+ run: |
  docker run --rm \
  -e CI=true \
  -v ${PWD}:/workspace \
  ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }} \
  make dev lint test doc build
- - run: |
- docker buildx build . \
- --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
- --cache-to type=registry,ref=ghcr.io/${{ github.repository }}/dev-cache:py${{ matrix.python-version }},mode=max \
- --file .devcontainer/Dockerfile \
- --push \
- --tag ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }} \
- --tag ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }}-${{ github.ref_name }} \
- --target dev
- - run: |
+ - name: Build the prod container
+ run: |
  docker buildx build . \
  --build-arg SCM_VERSION=${{ github.ref_name }} \
  --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
@@ -84,8 +83,20 @@ jobs:
  --tag ghcr.io/${{ github.repository }}:py${{ matrix.python-version }} \
  --tag ghcr.io/${{ github.repository }}:py${{ matrix.python-version }}-${{ github.ref_name }} \
  --target prod
- - run: docker run --rm ghcr.io/${{ github.repository }}:py${{ matrix.python-version }}
- - run: |
+ - name: Test the prod container
+ run: docker run --rm ghcr.io/${{ github.repository }}:py${{ matrix.python-version }}
+ - name: Push the dev container
+ run: |
+ docker buildx build . \
+ --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
+ --cache-to type=registry,ref=ghcr.io/${{ github.repository }}/dev-cache:py${{ matrix.python-version }},mode=max \
+ --file .devcontainer/Dockerfile \
+ --push \
+ --tag ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }} \
+ --tag ghcr.io/${{ github.repository }}/dev:py${{ matrix.python-version }}-${{ github.ref_name }} \
+ --target dev
+ - name: Push the prod container
+ run: |
  docker buildx build . \
  --build-arg SCM_VERSION=${{ github.ref_name }} \
  --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
@@ -105,8 +116,10 @@ jobs:
  package-publish:
  runs-on: ubuntu-22.04
  steps:
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- - uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Set up PDM
+ uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
  with:
  cache: true
  python-version: '3.12'

diff --git a/.gitlab/workflows/release.yml b/.gitlab/workflows/release.yml
@@ -61,15 +61,6 @@ container-publish:
  -v ${PWD}:/workspace \
  ${CI_REGISTRY_IMAGE}/dev:py${PYTHON_VERSION} \
  make dev lint test doc build
- - |
- docker buildx build . \
- --build-arg PYTHON_VERSION=${PYTHON_VERSION} \
- --cache-to type=registry,ref=${CI_REGISTRY_IMAGE}/dev-cache:py${PYTHON_VERSION},mode=max \
- --file .devcontainer/Dockerfile \
- --push \
- --tag ${CI_REGISTRY_IMAGE}/dev:py${PYTHON_VERSION} \
- --tag ${CI_REGISTRY_IMAGE}/dev:py${PYTHON_VERSION}-${CI_COMMIT_TAG} \
- --target dev
  - |
  docker buildx build . \
  --build-arg SCM_VERSION=${CI_COMMIT_TAG} \
@@ -80,6 +71,15 @@ container-publish:
  --tag ${CI_REGISTRY_IMAGE}:py${PYTHON_VERSION}-${CI_COMMIT_TAG} \
  --target prod
  - docker run --rm ${CI_REGISTRY_IMAGE}:py${PYTHON_VERSION}
+ - |
+ docker buildx build . \
+ --build-arg PYTHON_VERSION=${PYTHON_VERSION} \
+ --cache-to type=registry,ref=${CI_REGISTRY_IMAGE}/dev-cache:py${PYTHON_VERSION},mode=max \
+ --file .devcontainer/Dockerfile \
+ --push \
+ --tag ${CI_REGISTRY_IMAGE}/dev:py${PYTHON_VERSION} \
+ --tag ${CI_REGISTRY_IMAGE}/dev:py${PYTHON_VERSION}-${CI_COMMIT_TAG} \
+ --target dev
  - |
  docker buildx build . \
  --build-arg SCM_VERSION=${CI_COMMIT_TAG} \

diff --git a/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/ci.yml.jinja b/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/ci.yml.jinja
@@ -16,10 +16,12 @@ jobs:
  if: {{ '${{ !cancelled() && ! failure() }}' }}
  runs-on: {{ '${{ matrix.os }}' }}
  steps:
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
  with:
  fetch-depth: 0
- - uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
+ - name: Set up PDM
+ uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
  with:
  cache: true
  python-version: {{ '${{ matrix.python-version }}' }}
@@ -87,7 +89,8 @@ jobs:
  runs-on: ubuntu-22.04
  steps:
  - run: env | sort
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
  - name: Set up Git
  run: |
  git config --global user.name github-actions
@@ -127,7 +130,8 @@ jobs:
  echo "# :warning: GITHUB_TOKEN is used for semantic-release" >> $GITHUB_STEP_SUMMARY
  echo "The GITHUB_TOKEN is used instead of a bot token or PAT and will not emit the released publish event for the released workflow." >> $GITHUB_STEP_SUMMARY
  fi
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
  with:
  fetch-depth: 0
  persist-credentials: false

diff --git a/...ate/[% if repo_platform == 'github' %].github[% endif %]/workflows/devcontainer.yml.jinja b/...ate/[% if repo_platform == 'github' %].github[% endif %]/workflows/devcontainer.yml.jinja
@@ -27,35 +27,43 @@ jobs:
  runs-on: ubuntu-22.04
  steps:
  - run: env | sort
- - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- - run: docker login -u {{ '${{ github.actor }}' }} -p {{ '${{ secrets.GITHUB_TOKEN }}' }} ghcr.io
- - run: |
+ - name: Checkout repository
+ uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+ - name: Set up authentication
+ run: docker login -u {{ '${{ github.actor }}' }} -p {{ '${{ secrets.GITHUB_TOKEN }}' }} ghcr.io
+ - name: Set up BuildKit
+ run: |
  docker context create builder
  docker buildx create builder --name container --driver docker-container --use
  docker buildx inspect --bootstrap --builder container
- - run: |
+ - name: Build the dev container
+ run: |
  docker buildx build . \
  --build-arg PYTHON_VERSION={{ '${{ matrix.python-version }}' }} \
  --cache-from type=registry,ref=ghcr.io/{{ '${{ github.repository }}' }}/dev-cache:py{{ '${{ matrix.python-version }}' }} \
  --file .devcontainer/Dockerfile \
  --load \
  --tag ghcr.io/{{ '${{ github.repository }}' }}/dev:py{{ '${{ matrix.python-version }}' }} \
  --target dev
- - run: |
+ - name: Test the dev container
+ run: |
  docker run --rm \
  -e CI=true \
  -v ${PWD}:/workspace \
  ghcr.io/{{ '${{ github.repository }}' }}/dev:py{{ '${{ matrix.python-version }}' }} \
  make dev lint test doc build
- - run: |
+ - name: Build the prod container
+ run: |
  docker buildx build . \
  --build-arg PYTHON_VERSION={{ '${{ matrix.python-version }}' }} \
  --file .devcontainer/Dockerfile \
  --load \
  --tag ghcr.io/{{ '${{ github.repository }}' }}:py{{ '${{ matrix.python-version }}' }} \
  --target prod
- - run: docker run --rm ghcr.io/{{ '${{ github.repository }}' }}:py{{ '${{ matrix.python-version }}' }}
- - if: github.event_name != 'pull_request'
+ - name: Test the prod container
+ run: docker run --rm ghcr.io/{{ '${{ github.repository }}' }}:py{{ '${{ matrix.python-version }}' }}
+ - name: Push the dev container
+ if: github.event_name != 'pull_request'
  run: |
  docker buildx build . \
  --build-arg PYTHON_VERSION={{ '${{ matrix.python-version }}' }} \

diff --git a/...if repo_platform == 'github' %].github[% endif %]/workflows/readthedocs-preview.yml.jinja b/...if repo_platform == 'github' %].github[% endif %]/workflows/readthedocs-preview.yml.jinja
@@ -6,7 +6,8 @@ jobs:
  documentation-links:
  runs-on: ubuntu-22.04
  steps:
- - uses: readthedocs/actions/preview@cc0920454cf03ca8a3fbd3cbaa2ce2e509e70636 # v1.2
+ - name: Add Read the Docs preview's link to pull request
+ uses: readthedocs/actions/preview@cc0920454cf03ca8a3fbd3cbaa2ce2e509e70636 # v1.2
  with:
  project-slug: {{ repo_name }}
 on: