Post-v0.2.0 cleanup: diagrams, CI warnings, Docker Hub overview#5
Merged
Merged
Conversation
The box-drawing ASCII diagram did not render cleanly on GitHub. Swap it for a Mermaid flowchart in both the README and architecture.md so the two callers and the shared pipeline core display correctly.
GitHub flags every JS action on Node.js 20 as deprecated ahead of the June 2026 forced migration. Set FORCE_JAVASCRIPT_ACTIONS_TO_NODE24 at the workflow level in both workflows to run the actions on Node.js 24 now and clear the warnings. Safe to remove once Node 24 is the runner default.
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation and CI configuration as a post-v0.2.0 cleanup: it replaces the ASCII “architecture at a glance” diagrams with GitHub-native Mermaid flowcharts and opts GitHub Actions JavaScript actions into Node.js 24 to silence Node 20 deprecation warnings.
Changes:
- Replace ASCII architecture diagrams with Mermaid flowcharts in README and architecture docs.
- Add
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: trueat the workflow level in CI and release workflows.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Swaps ASCII architecture diagram for Mermaid flowchart (now needs a small accuracy tweak re: sentiment being optional). |
| docs/architecture.md | Swaps ASCII execution-modes diagram for Mermaid flowchart. |
| .github/workflows/release.yml | Adds workflow-level env var to run JS actions on Node 24 and silence Node 20 warnings. |
| .github/workflows/ci.yml | Adds workflow-level env var to run JS actions on Node 24 and silence Node 20 warnings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Version-control the Docker Hub repo overview as docs/dockerhub-overview.md and sync it (plus the short description) on every release via peter-evans/dockerhub-description in the docker-publish job, so the Docker Hub page can't drift from the repo. Reuses the existing DOCKERHUB_* secrets.
chris-colinsky
changed the title
Replace the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24 workaround with the durable fix used in openarmature-python: bump the warning-flagged actions to their latest Node-24-native majors and pin every action to a commit SHA (with a version comment) for supply-chain hardening. Bumped: checkout v4->v6, setup-python v5->v6, setup-uv v4->v8, upload-artifact v4->v7, download-artifact v4->v8, gh-release v1->v3. Docker actions are SHA-pinned at their current majors — no Node 20 warning forces a bump, and the docker-publish job runs only on a release tag.
The README Mermaid diagram showed sentiment as an unconditional core stage, but it is opt-in (off by default). Label it "sentiment (optional)" to match docs/architecture.md and the actual default.
Move the Docker Hub overview sync out of the release docker-publish job into a dedicated workflow triggered on changes to docs/dockerhub-overview.md and on workflow_dispatch. The page now updates whenever the overview changes (or on demand) instead of only when a version ships — and merging a change to the overview pushes it live without a release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up cleanup after v0.2.0. No release, no version bump.
Summary
README.mdanddocs/architecture.md. The ASCII version didn't render cleanly on GitHub; the Mermaid block renders natively. Sentiment is labeled optional in both to match the opt-in default.openarmature-python. Bumped: checkout v4→v6, setup-python v5→v6, setup-uv v4→v8, upload-artifact v4→v7, download-artifact v4→v8, action-gh-release v1→v3. Docker actions are SHA-pinned at their current majors (no warning forces a bump, anddocker-publishonly runs on a release tag).docs/dockerhub-overview.mdand sync it (plus the short description) via a dedicateddockerhub-description.ymlworkflow that triggers on changes to the overview file and onworkflow_dispatch. Decoupled from the release cycle, so the page updates whenever the overview changes or on demand — and merging this PR pushes the overview live without a release.Notes
openarmature-python.DOCKERHUB_USERNAME/DOCKERHUB_TOKENsecrets.