Repository navigation
Sync Funnel documentation from develop - #107
matthewpeterkort wants to merge 5 commits into
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8e49e3051b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| with: | ||
| branch: automation/sync-funnel-docs |
There was a problem hiding this comment.
Exclude Python bytecode from automated documentation commits
Whenever an upstream revision changes, the preceding unittest step creates scripts/__pycache__/ and tests/__pycache__/, neither of which is ignored by .gitignore (confirmed by running the tests locally). This step does not restrict add-paths, whose documented default is that “all new and modified files are added,” so each generated documentation PR also commits those binary build artifacts. Their checkout-dependent timestamps can cause further binary churn on subsequent updates to the open PR. Ignore Python bytecode or restrict the action to the intended documentation and navigation paths. See the action's input documentation.
Useful? React with 👍 / 👎.
The CALYPR site maintains a separate copy of Funnel documentation. This PR adds an automated, reviewable sync from
calypr/funnel'sdevelopbranch; it does not change the site's Funnel content directly.developdaily and open or update a PR when its revision changes. The sync tests and builds the site before opening the PR.develop, then adopt them automatically. The CALYPR landing and download pages remain site-owned.The first sync after Funnel #1474 merges will propose the Badger guide, remote-server guide for calypr/funnel#362, and the reconciled reference pages. The generated PR still needs review and merge before publication.
Validation: sync unit tests, Zensical build, and actionlint passed. A simulated first sync against the Funnel PR branch verified that all three protected guides transfer and that Badger and remote-server pages appear in navigation.
The organization and repository settings for Actions-created PRs are enabled. The scheduled workflow becomes active after this PR merges; PR workflows created with
GITHUB_TOKENmay require approval.