💡 Ensure all jobs have headers and are appropriately grouped

TeoZosa · Aug 7, 2021 · 8b3c18e · 8b3c18e
1 parent 89fcd4c
commit 8b3c18e
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 13 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,7 +15,6 @@ on:  # yamllint disable-line rule:truthy
 jobs:
 
   # Quality jobs ----------------------
-
   code-quality:
     name: Code Quality
     runs-on: "ubuntu-latest"
@@ -59,8 +58,8 @@ jobs:
         run: |
           make pre-commit
 
-  # Security jobs ----------------------
 
+  # Security jobs ----------------------
   dependency-security-vulnerability-analysis:
     name: Dependency Security Vulnerability Analysis
     runs-on: "ubuntu-latest"
@@ -92,8 +91,8 @@ jobs:
         run: |
           make scan-dependencies
 
-  # Code quality AND security job ----------------------
 
+  # Code quality AND security job ----------------------
   semgrep:
     runs-on: ubuntu-latest
     name: Semgrep

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -10,7 +10,6 @@ on:  # yamllint disable-line rule:truthy
 jobs:
 
   # Shared tag & version number info ----------------------
-
   get-tag-xor-dev-version:
     name: Get tags and version numbers
     runs-on: ubuntu-latest
@@ -67,8 +66,8 @@ jobs:
           poetry version "${DEV_VERSION}" &&
           echo "::set-output name=version::${DEV_VERSION}"
 
-  # Release notes publication ----------------------
 
+  # Release notes publication ----------------------
   publish-release-notes:
     name: Publish release notes
     runs-on: ubuntu-latest

diff --git a/{{cookiecutter.project_slug}}/.github/workflows/ci.yml b/{{cookiecutter.project_slug}}/.github/workflows/ci.yml
@@ -15,7 +15,6 @@ on:  # yamllint disable-line rule:truthy
 jobs:
 
   # Quality jobs ----------------------
-
   code-quality:
     name: Code Quality
     runs-on: "ubuntu-latest"
@@ -59,8 +58,8 @@ jobs:
         run: |
           make pre-commit
 
-  # Security jobs ----------------------
 
+  # Security jobs ----------------------
   dependency-security-vulnerability-analysis:
     name: Dependency Security Vulnerability Analysis
     runs-on: "ubuntu-latest"
@@ -92,8 +91,8 @@ jobs:
         run: |
           make scan-dependencies
 
-  # Code quality AND security job ----------------------
 
+  # Code quality AND security job ----------------------
   semgrep:
     runs-on: ubuntu-latest
     name: Semgrep
@@ -112,7 +111,6 @@ jobs:
           config: r/python
 
   # Tests jobs ------------------------
-
   test:
     name: Python {{ "${{ matrix.python-version }}" }}
     runs-on: "ubuntu-latest"
@@ -159,6 +157,7 @@ jobs:
           file: ./.tox/coverage.xml
           fail_ci_if_error: false
 
+  # Performance testing jobs ------------------------
   test-performance:
     name: Performance testing for Python {{ "${{ matrix.python-version }}" }}
     runs-on: "ubuntu-latest"
@@ -200,6 +199,8 @@ jobs:
           envname="py${TOX_COMPATIBLE_VERSION}-benchmark" && \
           make "test-${envname}"
 
+
+  # Mutation testing jobs ------------------------
   test-mutations:
     name: Mutation testing
     runs-on: "ubuntu-latest"

diff --git a/{{cookiecutter.project_slug}}/.github/workflows/release.yml b/{{cookiecutter.project_slug}}/.github/workflows/release.yml
@@ -16,7 +16,6 @@ on:  # yamllint disable-line rule:truthy
 jobs:
 
   # Shared tag & version number info ----------------------
-
   get-tag-xor-dev-version:
     name: Get tags and version numbers
     runs-on: ubuntu-latest
@@ -73,6 +72,7 @@ jobs:
           poetry version "${DEV_VERSION}" &&
           echo "::set-output name=version::${DEV_VERSION}"
 
+
   {%- if cookiecutter.project_type == 'package' %}
   # Package build ----------------------
   package-build:
@@ -179,7 +179,6 @@ jobs:
           repository_url: https://test.pypi.org/legacy/
 
   # Install Verification ----------------------
-
   verify-user-install:
     strategy:
       matrix:
@@ -222,7 +221,7 @@ jobs:
           {{cookiecutter.project_slug}} --help
           {{cookiecutter.project_slug}} --version
         shell: bash
-      {%- endif %}
+  {%- endif %}
 
   # Docker image build and upload ----------------------
   docker-image-build-and-upload:
@@ -267,7 +266,6 @@ jobs:
         run: echo {{ "${{ steps.docker_build.outputs.digest }}" }}
 
   # Release notes publication ----------------------
-
   publish-release-notes:
     name: Publish release notes
     runs-on: ubuntu-latest