Merge pull request #42 from John-Robbins/more-docs

- Wrote up GitHub Actions experience. Closes #18.
- Added pyreadline3 dependency to docs. Closes #9.
- Got hack-around working for broken matrix job status. Closes #41.
- Prepared 0.9.1 release. Closes #39.

.github/workflows/CI.yml

@@ -154,6 +154,9 @@ jobs:
     - name: Pylint Lint
       run: pylint --rcfile pyproject.toml src/ tests/
 
+  # Major bug alert. This is a job with a matrix and there's a 4+ year old bug
+  # where matrix jobs don't properly report status.
+  # https://github.com/orgs/community/discussions/26822
   test-cov-job:
     needs: [fight-github-job, lint-types-job]
     name: "Tests & Coverage"
@@ -222,8 +225,29 @@ jobs:
         # SemVer be damned!
         include-hidden-files: true
 
-  cov-report-job:
+  # Here's the workaround for GitHub matrix jobs not having proper status
+  # reporting.
+  # https://github.com/orgs/community/discussions/26822#discussioncomment-5122101
+  # https://github.com/sounisi5011/npm-packages/blob/2a5ca2de696eeb8b40a38de90580441c4c6c96e0/.github/workflows/ci.yaml#L482-L498
+  the-sad-did-github-matrix-succeed-job:
     needs: [fight-github-job, test-cov-job]
+    name: "Did Test & Coverage Succeed?"
+    # Note the different condition here. If it wasn't always(), PR's on
+    # protected branches would never run.
+    if: ${{always()}}
+    runs-on: ubuntu-latest
+    steps:
+    - name: "Why is this not part of a matrix job?"
+      if: >-
+        ${{
+             contains(needs.*.result, 'failure')
+          || contains(needs.*.result, 'cancelled')
+        }}
+      run: exit 1
+
+
+  cov-report-job:
+    needs: [fight-github-job, the-sad-did-github-matrix-succeed-job]
     name: "Coverage Report"
     # Only run on changed code files.
     if: ${{needs.fight-github-job.outputs.code == 'true'}}

.vscode/ltex.dictionary.en-US.txt

@@ -63,3 +63,17 @@ Otten
 IntelliSense
 Batchelder
 scriv
+jekyll
+Wintellect
+CodeSpaces
+Arie
+Bovenberg
+actionlint
+rhysd
+NuMega
+monorepo
+@dorny
+%raw%
+%endraw%
+hack-arounds
+mergeable

.vscode/ltex.hiddenFalsePositives.en-US.txt

@@ -26,3 +26,10 @@
 {"rule":"POSSESSIVE_APOSTROPHE","sentence":"^\\QThe examples directory holds sample Tiny BASIC programs for your enjoyment.\\E$"}
 {"rule":"UNLIKELY_OPENING_PUNCTUATION","sentence":"^\\Q:steam_locomotive: Change Log\\E$"}
 {"rule":"WORD_CONTAINS_UNDERSCORE","sentence":"^\\Q:steam_locomotive: Change Log\\E$"}
+{"rule":"UNLIKELY_OPENING_PUNCTUATION","sentence":"^\\Q:scream_cat: ^6: Why does it seem Ruby is so hard to install on macOS?\\E$"}
+{"rule":"WORD_CONTAINS_UNDERSCORE","sentence":"^\\Q:scream_cat: ^6: Why does it seem Ruby is so hard to install on macOS?\\E$"}
+{"rule":"UNLIKELY_OPENING_PUNCTUATION","sentence":"^\\Q:joy_cat: Some of you know where this is going.\\E$"}
+{"rule":"WORD_CONTAINS_UNDERSCORE","sentence":"^\\Q:joy_cat: Some of you know where this is going.\\E$"}
+{"rule":"TOO_LONG_PARAGRAPH","sentence":"^\\Q^8: And pointing the fickle finger of blame!\\E$"}
+{"rule":"UNLIKELY_OPENING_PUNCTUATION","sentence":"^\\Q:crossed_fingers: (Thanks for your patience!)\\E$"}
+{"rule":"WORD_CONTAINS_UNDERSCORE","sentence":"^\\Q:crossed_fingers: (Thanks for your patience!)\\E$"}

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ---
 
+## 0.9.1 (2024-09-09)
+
+---
+
+- Fixed CI.yml to work around the bug in GitHub Actions where matrix jobs don't have any status of the sub jobs. See [#41](https://github.com/John-Robbins/tbp/issues/41).
+- Added the [GitHub and GitHub Actions](https://john-robbins.github.io/tbp/project-notes#github-and-github-actions) section to the documentation.
+- Added the pyreadline3 dependency to the [documentation](https://john-robbins.github.io/tbp/project-notes#small-python-friction-points).
+- Updated the README and [Getting Started Installation](https://john-robbins.github.io/tbp/getting-started#installation) section to point to the Latest releases.
+- This is basically a practice release to ensure I have the steps down. :crossed_fingers: (Thanks for your patience!)
+
 ## 0.9.0 (2024-09-06)
 
 ---

README.md

@@ -60,7 +60,7 @@ It seemed nuts to put this up on PyPI, which is for important modules, not learn
 
 ### Cloning and Installing
 
-Download the code from here as a .ZIP file. Expand that file into a directory, then execute the following.
+Download the code from the [Latest](https://github.com/John-Robbins/tbp/releases/latest) release. Expand the compressed file into a directory, then execute the following.
 
 ```bash
 % pip install .

docs/_data/version.yml

@@ -1 +1 @@
-number: 0.9.0
+number: 0.9.1

docs/docs/getting-started.md

@@ -28,7 +28,7 @@ It seemed nuts to put this up on PyPI, which is for important modules, not learn
 
 ### Cloning and Installing
 
-Download the code from here as a .ZIP file. Expand that file into a directory, then execute the following.
+Download the code from the [Latest](https://github.com/John-Robbins/tbp/releases/latest) release. Expand the compressed file into a directory, then execute the following.
 
 ```bash
 % pip install .