ci: remove redundant workflows uncovered by post-refactor survey - #249
Open
jonathanhhb wants to merge 1 commit into
Open
ci: remove redundant workflows uncovered by post-refactor survey#249jonathanhhb wants to merge 1 commit into
jonathanhhb wants to merge 1 commit into
Conversation
Two workflows became redundant after the RAG/CI reorganization landed (#241, #246). Cleaning them up to reduce cognitive load — 6 workflows became 5, and the two removals eliminate double-work that was silently happening on every release. ## 1. Delete .github/workflows/mkdocs-pr.yml This workflow ran `mkdocs build` on PRs to validate the docs site still built. That's already covered by github-actions.yml's `docs` tox matrix entry, which runs `tox -e docs` (which itself runs `mkdocs build`) on every PR. Both workflows produced the same validation signal. Only unique bit in mkdocs-pr.yml was the site-preview artifact upload (14-day retention). Given the docs site is the canonical render location (laser.idmod.org/laser-generic/tutorials/) and gets updated on every main-push, the value of a per-PR downloadable site preview is marginal. Removed. ## 2. Remove docs-deploy job from release-publish.yml The `docs-deploy` job in release-publish.yml did: - Fresh in-band notebook execution (MKDOCS_EXECUTE_NOTEBOOKS=true) - mkdocs gh-deploy --force --dirty That was necessary before we had the Execute Notebooks + artifact overlay pattern. Now that path is fully covered by mkdocs-ghp.yml, which fires automatically when the release commit hits main and consumes the executed_nbs artifact produced by Execute Notebooks. The release-time deploy was therefore double-work — mkdocs-ghp already deployed a fresh-artifact-backed site before release-publish's dispatch even ran, and docs-deploy then re-deployed with in-band execution (~30 min slower). Also updated `needs: [build, docs-deploy]` in the `release` and `publish` jobs to just `needs: [build]` — those jobs shouldn't gate on a docs deploy at all. Whether the docs site deploys or not is a main-branch concern, not a release-artifact concern. Left a comment in the workflow explaining where the docs deploy happens now so future maintainers don't add it back.
Contributor
There was a problem hiding this comment.
Pull request overview
Removes redundant CI workflows/jobs after the docs/RAG CI refactor, so the release workflow focuses only on release artifacts while docs deployment remains handled by the dedicated MkDocs deploy pipeline.
Changes:
- Deletes the PR-only MkDocs build workflow (
mkdocs-pr.yml) that duplicated existing docs validation. - Removes the
docs-deployjob fromrelease-publish.ymland updates downstreamneeds:to depend only onbuild. - Adds an inline note in
release-publish.ymldocumenting where docs deployment happens now.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/release-publish.yml | Drops redundant docs deployment from the release workflow and unblocks release/publish from depending on it. |
| .github/workflows/mkdocs-pr.yml | Deletes a redundant PR docs-build workflow that overlapped with the main CI docs validation path. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
|
Generally looks good, though I think it would be good to retain the artifact upload bit so the output can be viewed (it's not uncommon for the build to be green but for text to be rendered differently than is desired). |
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.
Summary
Post-refactor cleanup. Two workflows became redundant once the RAG/CI reorganization landed (#241, #246). Deleting them: 6 workflows → 5, and eliminates two spots where CI was doing the same work twice.
Changes
1. Delete
.github/workflows/mkdocs-pr.ymlDuplicated
github-actions.yml'sdocstox matrix entry — both ranmkdocs buildon every PR. Only unique bit was uploading the built site as a 14-day preview artifact, but the canonical render location is laser.idmod.org/laser-generic/tutorials/ (updated on every main-push per #246), so the per-PR preview artifact is marginal.2. Remove
docs-deployjob fromrelease-publish.ymlBefore we had the Execute Notebooks + artifact overlay pattern, releases had a bespoke docs deploy that did in-band notebook execution (
MKDOCS_EXECUTE_NOTEBOOKS=true) followed bymkdocs gh-deploy. That's now fully covered bymkdocs-ghp.yml, which fires when the release commit hits main and deploys with the freshexecuted_nbsartifact.Effect on a typical release:
Also fixed
needs: [build, docs-deploy]in thereleaseandpublishjobs down toneeds: [build]. Those jobs shouldn't gate on a docs deploy; the docs deploy is a main-branch concern, not a release-artifact concern.Left an inline comment in the workflow explaining where the docs deploy happens now so future maintainers don't reintroduce it.
What stays
Four workflows remain, each with a distinct role:
github-actions.ymldocsmatrix entry (validates mkdocs build) + ruff / typingexecute-notebooks.ymlexecuted_nbsartifactbuild-combined-doc.ymlmkdocs-ghp.ymlrelease-publish.ymlTest plan
needs: