chore: Generate coverage badge alongside reports. (#108)

huxuan · Sep 4, 2023 · 59cae68 · 59cae68
1 parent 155fbec
commit 59cae68
Show file tree

Hide file tree

Showing 12 changed files with 70 additions and 14 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,10 +30,6 @@ jobs:
       - run: env | sort
       - run: make dev-test
       - run: make test
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          flags: ${{ matrix.python-version }}
     strategy:
       matrix:
         python-version:

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -18,7 +18,6 @@
     "autofix",
     "automodule",
     "cobertura",
-    "codecov",
     "elif",
     "endmacro",
     "epub",
@@ -83,6 +82,7 @@
     "author_email",
     "repo_host_type",
     "repo_host",
+    "page_host",
     "ci",
     "repo_namespace",
     "repo_name",

diff --git a/Makefile b/Makefile
@@ -129,11 +129,12 @@ docs-autobuild:
 docs-mypy:
 	${PIPRUN} python -m mypy src test --html-report ${PUBLIC_DIR}/reports/mypy
 
-# Generate coverage reports.
+# Generate coverage reports and badge.
 docs-coverage:
 	${PIPRUN} python -m coverage erase
 	${PIPRUN} python -m coverage run -m pytest
 	${PIPRUN} python -m coverage html -d ${PUBLIC_DIR}/reports/coverage
+	${PIPRUN} bash scripts/generate-coverage-badge.sh ${PUBLIC_DIR}/reports/coverage
 
 # Generate all reports.
 reports: docs-mypy docs-coverage

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 A development-focused Python project template with various integrations, configurations and modules.
 
 [![CI Status](https://github.com/serious-scaffold/serious-scaffold-python/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/serious-scaffold/serious-scaffold-python/actions/workflows/ci.yml)
-[![codecov](https://codecov.io/gh/serious-scaffold/serious-scaffold-python/branch/main/graph/badge.svg?token=4JPKXI122N)](https://codecov.io/gh/serious-scaffold/serious-scaffold-python)
+[![Coverage](https://img.shields.io/endpoint?url=https://serious-scaffold.github.io/serious-scaffold-python/reports/coverage/coverage_badge.json)](https://serious-scaffold.github.io/serious-scaffold-python/reports/coverage)
 [![Documentation Status](https://readthedocs.org/projects/serious-scaffold-python/badge/)](https://serious-scaffold-python.readthedocs.io/)
 [![GitHub](https://img.shields.io/github/license/serious-scaffold/serious-scaffold-python)](https://github.com/serious-scaffold/serious-scaffold-python/blob/main/LICENSE)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/serious-scaffold)](https://pypi.org/project/serious-scaffold/)

diff --git a/copier.yaml b/copier.yaml
@@ -40,6 +40,16 @@ repo_host:
   help: 'Specify the host of the self-managed GitLab:'
   type: str
   when: '{{ repo_host_type == "gitlab-self-managed" }}'
+page_host:
+  default: |-
+    [% if repo_host_type == 'github.com' -%]
+      github.io
+    [%- elif repo_host_type == 'gitlab.com' -%]
+      gitlab.io
+    [%- endif %]
+  help: 'Specify the host of the self-managed GitLab Pages:'
+  type: str
+  when: '{{ repo_host_type == "gitlab-self-managed" }}'
 repo_namespace:
   default: '{{ organization_name|lower|replace(" ", "-") }}'
   help: 'Indicate the GitHub Repository Owner or GitLab Namespace. This is typically the account name of the author or the organization:'

diff --git a/includes/variable.jinja b/includes/variable.jinja
@@ -10,6 +10,15 @@
   [%- endif %]
 [%- endmacro %]
 
+[% macro page_base_url() -%]
+  [% if repo_host_type == 'github.com' -%]
+    {{ repo_namespace }}.github.io/{{ repo_name }}
+  [%- elif repo_host_type == 'gitlab.com' or repo_host_type == 'gitlab-self-managed' -%]
+    [%- set repo_namespace_root = repo_namespace.split("/")[0] -%]
+    {{ repo_namespace_root }}.{{ page_host }}{{ repo_namespace | replace(repo_namespace_root, "", 1) }}/{{ repo_name }}
+  [%- endif %]
+[%- endmacro %]
+
 [% macro ci_badge() -%]
   [% if repo_host_type == 'github.com' -%]
     [![CI Status](https://{{ repo_url() }}/actions/workflows/ci.yml/badge.svg?branch=main)](https://{{ repo_url() }}/actions/workflows/ci.yml)
@@ -18,6 +27,10 @@
   [%- endif %]
 [%- endmacro %]
 
+[% macro coverage_badge() -%]
+  [![Coverage](https://img.shields.io/endpoint?url=https://{{ page_base_url() }}/reports/coverage/coverage_badge.json)](https://{{ page_base_url() }}/reports/coverage)
+[%- endmacro %]
+
 [% macro license_badge() -%]
   [% if repo_host_type == 'github.com' -%]
     [![GitHub](https://img.shields.io/github/license/{{ repo_namespace }}/{{ repo_name }})]

diff --git a/scripts/generate-coverage-badge.sh b/scripts/generate-coverage-badge.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+TOTAL_COVERAGE=$(coverage report --format=total)
+COLOR="red"
+
+if [ "$TOTAL_COVERAGE" -gt 90 ]; then
+    COLOR="green"
+elif [ "$TOTAL_COVERAGE" -gt 75 ]; then
+    COLOR="yellow"
+fi
+
+cat << EOF > "${1:-.}/coverage_badge.json"
+{
+  "schemaVersion": 1,
+  "label": "coverage",
+  "message": "${TOTAL_COVERAGE}%",
+  "color": "${COLOR}"
+}
+EOF
diff --git a/template/.vscode/settings.json b/template/.vscode/settings.json
@@ -18,7 +18,6 @@
     "autofix",
     "automodule",
     "cobertura",
-    "codecov",
     "elif",
     "endmacro",
     "epub",
@@ -83,6 +82,7 @@
     "author_email",
     "repo_host_type",
     "repo_host",
+    "page_host",
     "ci",
     "repo_namespace",
     "repo_name",

diff --git a/template/Makefile.jinja b/template/Makefile.jinja
@@ -131,11 +131,12 @@ docs-autobuild:
 docs-mypy:
 	${PIPRUN} python -m mypy src test --html-report ${PUBLIC_DIR}/reports/mypy
 
-# Generate coverage reports.
+# Generate coverage reports and badge.
 docs-coverage:
 	${PIPRUN} python -m coverage erase
 	${PIPRUN} python -m coverage run -m pytest
 	${PIPRUN} python -m coverage html -d ${PUBLIC_DIR}/reports/coverage
+	${PIPRUN} bash scripts/generate-coverage-badge.sh ${PUBLIC_DIR}/reports/coverage
 
 # Generate all reports.
 reports: docs-mypy docs-coverage

diff --git a/template/README.md.jinja b/template/README.md.jinja
@@ -1,12 +1,13 @@
 [% from pathjoin("includes", "variable.jinja") import ci_badge with context -%]
+[% from pathjoin("includes", "variable.jinja") import coverage_badge with context -%]
 [% from pathjoin("includes", "variable.jinja") import license_badge with context -%]
 [% from pathjoin("includes", "variable.jinja") import repo_url with context -%]
 # {{ project_name }}
 
 {{ project_description }}
 
 {{ ci_badge() }}
-[![codecov](https://codecov.io/gh/{{ repo_namespace }}/{{ repo_name }}/branch/main/graph/badge.svg?token=4JPKXI122N)](https://codecov.io/gh/{{ repo_namespace }}/{{ repo_name }})
+{{ coverage_badge() }}
 [![Documentation Status](https://readthedocs.org/projects/{{ repo_name }}/badge/)](https://{{ repo_name }}.readthedocs.io/)
 {{ license_badge() }}
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/{{ package_name }})](https://pypi.org/project/{{ package_name }}/)

diff --git a/template/[% if repo_host_type == 'github.com' %].github[% endif %]/workflows/ci.yml.jinja b/template/[% if repo_host_type == 'github.com' %].github[% endif %]/workflows/ci.yml.jinja
@@ -39,10 +39,6 @@ jobs:
       - run: env | sort
       - run: make dev-test
       - run: make test
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          flags: {{ '${{ matrix.python-version }}' }}
     strategy:
       matrix:
         python-version:

diff --git a/template/scripts/generate-coverage-badge.sh b/template/scripts/generate-coverage-badge.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+TOTAL_COVERAGE=$(coverage report --format=total)
+COLOR="red"
+
+if [ "$TOTAL_COVERAGE" -gt 90 ]; then
+    COLOR="green"
+elif [ "$TOTAL_COVERAGE" -gt 75 ]; then
+    COLOR="yellow"
+fi
+
+cat << EOF > "${1:-.}/coverage_badge.json"
+{
+  "schemaVersion": 1,
+  "label": "coverage",
+  "message": "${TOTAL_COVERAGE}%",
+  "color": "${COLOR}"
+}
+EOF