ci: format yml files and add all-green step for branch protection

Author: WSH032

.github/workflows/docs.yml

@@ -1,7 +1,9 @@
 # copy from: https://github.com/frankie567/httpx-ws/blob/main/.github/workflows/docs.yml
 
-name: Deploy documentation
+# WARNING: Do not change the name of this file, keep `docs.yml`.
+# markdown badges are hard-coded to point to this file.
 
+name: Deploy documentation
 
 # Since document updates may be frequent,
 # we do not run tests when deploying documents,

.github/workflows/lint-test.yml

@@ -1,8 +1,8 @@
 # WARNING: Do not change the name of this file, keep `lint-test.yml`.
+# `workflow_call` needs the name of the workflow file to work.
 
 name: Lint check and test
 
-
 # We only automatically run checks for PRs.
 # It is best to avoid direct commits to the main branch, instead make a PR for checks.
 # For the pushes to the main branch, the checks is done by `publish.yml` when publish.
@@ -12,7 +12,6 @@ on:
   # NOTE: set `secrets: inherit` when call this workflow from other workflow.
   workflow_call:
 
-
 jobs:
   lint-check:
     runs-on: ubuntu-latest
@@ -63,3 +62,16 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
           fail_ci_if_error: true
+
+  # https://github.com/marketplace/actions/alls-green#why
+  lint-test-all-green: # This job does nothing and is only used for the branch protection
+    if: always() # IMPORTANT: mandatory
+    needs:
+      - lint-check
+      - test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/publish.yml

@@ -1,9 +1,10 @@
 # refer to: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
 
-name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+# WARNING: Do not change the name of this file, keep `publish.yml`.
+# "trusted publishing" will check the name of the workflow file.
+
+name: Publish Python 🐍 distribution 📦 to PyPI
 
-# NOTE: We do not restrict branches here,
-# instead restrict branches in the `environment` - `pypi`.
 on:
   push:
     tags: