Refactor GitHub Actions shield functions, and work towards new shields in shields block.

Author: domdfcoding

repo_helper/_docs_shields.py

@@ -67,6 +67,7 @@
 		"make_docs_typing_shield",
 		"make_docs_pre_commit_shield",
 		"make_docs_pre_commit_ci_shield",
+		"make_docs_actions_shield",
 		]
 
 
@@ -101,26 +102,45 @@ def make_docs_docs_check_shield(repo_name: str, username: str) -> str:
 	:alt: Docs Check Status"""
 
 
-def make_docs_actions_linux_shield(
+def make_docs_actions_shield(
 		repo_name: str,
 		username: str,
+		name: str,
+		alt: str,
 		) -> str:
 	"""
 	Create a shield to indicate the status of the tests on Linux.
 
 	:param repo_name: The name of the repository.
 	:param username: The username of the GitHub account that owns the repository.
+	:param name: The name of the workflow.
+	:param alt: Alternative text for the image when it cannot be shown.
 
 	:return: The shield.
+
+	.. versionadded:: 2020.12.16
 	"""
 
-	return """\
+	return f"""\
 .. actions-shield::
-	:workflow: Linux
-	:alt: Linux Test Status"""
+	:workflow: {name}
+	:alt: {alt}"""
 
 
-make_docs_actions_linux_shield = make_docs_actions_linux_shield
+def make_docs_actions_linux_shield(
+		repo_name: str,
+		username: str,
+		) -> str:
+	"""
+	Create a shield to indicate the status of the tests on Linux.
+
+	:param repo_name: The name of the repository.
+	:param username: The username of the GitHub account that owns the repository.
+
+	:return: The shield.
+	"""
+
+	return make_docs_actions_shield(repo_name, username, "Linux", "Linux Test Status")
 
 
 def make_docs_actions_windows_shield(repo_name: str, username: str) -> str:
@@ -133,10 +153,7 @@ def make_docs_actions_windows_shield(repo_name: str, username: str) -> str:
 	:return: The shield.
 	"""
 
-	return """\
-.. actions-shield::
-	:workflow: Windows
-	:alt: Windows Test Status"""
+	return make_docs_actions_shield(repo_name, username, "Windows", "Windows Test Status")
 
 
 def make_docs_actions_macos_shield(repo_name: str, username: str) -> str:
@@ -149,10 +166,7 @@ def make_docs_actions_macos_shield(repo_name: str, username: str) -> str:
 	:return: The shield.
 	"""
 
-	return """\
-.. actions-shield::
-	:workflow: macOS
-	:alt: macOS Test Status"""
+	return make_docs_actions_shield(repo_name, username, "macOS", "macOS Test Status")
 
 
 def make_docs_requires_shield(repo_name: str, username: str) -> str:

repo_helper/blocks/__init__.py

@@ -36,9 +36,7 @@
 
 # this package
 from repo_helper._docs_shields import (
-		make_docs_actions_linux_shield,
-		make_docs_actions_macos_shield,
-		make_docs_actions_windows_shield,
+		make_docs_actions_shield,
 		make_docs_activity_shield,
 		make_docs_codefactor_shield,
 		make_docs_conda_platform_shield,
@@ -62,9 +60,7 @@
 		make_docs_wheel_shield
 		)
 from repo_helper.shields import (
-		make_actions_linux_shield,
-		make_actions_macos_shield,
-		make_actions_windows_shield,
+		make_actions_shield,
 		make_activity_shield,
 		make_codefactor_shield,
 		make_conda_platform_shield,
@@ -394,9 +390,7 @@ def set_readme_mode(self) -> None:
 		Create shields for insertion into ``README.rst``.
 		"""
 
-		self.make_actions_linux_shield = make_actions_linux_shield
-		self.make_actions_macos_shield = make_actions_macos_shield
-		self.make_actions_windows_shield = make_actions_windows_shield
+		self.make_actions_shield = make_actions_shield
 		self.make_activity_shield = make_activity_shield
 		self.make_codefactor_shield = make_codefactor_shield
 		self.make_conda_platform_shield = make_conda_platform_shield
@@ -424,9 +418,7 @@ def set_docs_mode(self) -> None:
 		Create shields for insertion into Sphinx documentation.
 		"""
 
-		self.make_actions_linux_shield = make_docs_actions_linux_shield
-		self.make_actions_macos_shield = make_docs_actions_macos_shield
-		self.make_actions_windows_shield = make_docs_actions_windows_shield
+		self.make_actions_shield = make_docs_actions_shield
 		self.make_activity_shield = make_docs_activity_shield
 		self.make_codefactor_shield = make_docs_codefactor_shield
 		self.make_conda_platform_shield = make_docs_conda_platform_shield
@@ -482,6 +474,13 @@ def make(self) -> str:
 		substitutions["license"] = self.make_license_shield(repo_name, username)
 		substitutions["language"] = self.make_language_shield(repo_name, username)
 
+		sections["QA"] = ["codefactor", "actions_macos"]
+		substitutions["codefactor"] = self.make_codefactor_shield(repo_name, username)
+		sections["QA"].append("actions_flake8")
+		substitutions["actions_flake8"] = self.make_actions_shield(repo_name, username, "Flake8", "Flake8 Status")
+		sections["QA"].append("actions_mypy")
+		substitutions["actions_mypy"] = self.make_actions_shield(repo_name, username, "mypy", "mypy status")
+
 		if self.docs:
 			sections["Docs"] = ["docs", "docs_check"]
 			substitutions["docs"] = self.make_rtfd_shield(repo_name, self.docs_url)
@@ -491,22 +490,37 @@ def make(self) -> str:
 
 		if "Linux" in self.platforms:
 			sections["Tests"].append("actions_linux")
-			substitutions["actions_linux"] = self.make_actions_linux_shield(repo_name, username)
+			substitutions["actions_linux"] = self.make_actions_shield(
+					repo_name,
+					username,
+					"Linux",
+					"Linux Test Status",
+					)
 		if "Windows" in self.platforms:
 			sections["Tests"].append("actions_windows")
-			substitutions["actions_windows"] = self.make_actions_windows_shield(repo_name, username)
+			substitutions["actions_windows"] = self.make_actions_shield(
+					repo_name,
+					username,
+					"Windows",
+					"Windows Test Status",
+					)
 		if "macOS" in self.platforms:
 			sections["Tests"].append("actions_macos")
-			substitutions["actions_macos"] = self.make_actions_macos_shield(repo_name, username)
+			substitutions["actions_macos"] = self.make_actions_shield(
+					repo_name,
+					username,
+					"macOS",
+					"macOS Test Status",
+					)
 
 		if self.tests:
 			sections["Tests"].append("coveralls")
 			substitutions["coveralls"] = self.make_coveralls_shield(repo_name, username)
 
 		sections["Tests"].append("codefactor")
-		substitutions["codefactor"] = self.make_codefactor_shield(repo_name, username)
 
 		if self.pre_commit:
+			sections["QA"].append("pre_commit_ci")
 			sections["Tests"].append("pre_commit_ci")
 			substitutions["pre_commit_ci"] = self.make_pre_commit_ci_shield(repo_name, username)
 

repo_helper/shields.py

@@ -25,11 +25,9 @@
 
 # stdlib
 import datetime
+import urllib.parse
 from typing import Union
 
-# 3rd party
-from typing_extensions import Literal
-
 __all__ = [
 		"make_actions_linux_shield",
 		"make_actions_macos_shield",
@@ -57,6 +55,7 @@
 		"make_actions_linux_shield",
 		"make_typing_shield",
 		"make_wheel_shield",
+		"make_actions_shield",
 		]
 
 
@@ -94,20 +93,37 @@ def make_docs_check_shield(repo_name: str, username: str) -> str:
 	:alt: Docs Check Status"""
 
 
-def make_actions_linux_shield(repo_name: str, username: str) -> str:
+def make_actions_shield(repo_name: str, username: str, name: str, alt: str) -> str:
 	"""
 	Create a shield to indicate the status of the tests on Linux.
 
 	:param repo_name: The name of the repository.
 	:param username: The username of the GitHub account that owns the repository.
+	:param name: The name of the workflow.
+	:param alt: Alternative text for the image when it cannot be shown.
 
 	:return: The shield.
+
+	.. versionadded:: 2020.12.16
 	"""
 
 	return f"""\
-.. image:: https://github.com/{username}/{repo_name}/workflows/Linux/badge.svg
-	:target: https://github.com/{username}/{repo_name}/actions?query=workflow%3A%22Linux%22
-	:alt: Linux Test Status"""
+.. image:: https://github.com/{username}/{repo_name}/workflows/{name}/badge.svg
+	:target: https://github.com/{username}/{repo_name}/actions?query=workflow%3A%22{urllib.parse.quote(name)}%22
+	:alt: {alt}"""
+
+
+def make_actions_linux_shield(repo_name: str, username: str) -> str:
+	"""
+	Create a shield to indicate the status of the tests on Linux.
+
+	:param repo_name: The name of the repository.
+	:param username: The username of the GitHub account that owns the repository.
+
+	:return: The shield.
+	"""
+
+	return make_actions_shield(repo_name, username, "Linux", "Linux Test Status")
 
 
 def make_actions_windows_shield(repo_name: str, username: str) -> str:
@@ -120,10 +136,7 @@ def make_actions_windows_shield(repo_name: str, username: str) -> str:
 	:return: The shield.
 	"""
 
-	return f"""\
-.. image:: https://github.com/{ username }/{ repo_name }/workflows/Windows/badge.svg
-	:target: https://github.com/{ username }/{ repo_name }/actions?query=workflow%3A%22Windows%22
-	:alt: Windows Test Status"""
+	return make_actions_shield(repo_name, username, "Windows", "Windows Test Status")
 
 
 def make_actions_macos_shield(repo_name: str, username: str) -> str:
@@ -136,10 +149,7 @@ def make_actions_macos_shield(repo_name: str, username: str) -> str:
 	:return: The shield.
 	"""
 
-	return f"""\
-.. image:: https://github.com/{ username }/{ repo_name }/workflows/macOS/badge.svg
-	:target: https://github.com/{ username }/{ repo_name }/actions?query=workflow%3A%22macOS%22
-	:alt: macOS Test Status"""
+	return make_actions_shield(repo_name, username, "macOS", "macOS Test Status")
 
 
 def make_requires_shield(repo_name: str, username: str) -> str: