Stabilize Copilot review setup for MkDocs installs and builds - #313
Conversation
Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Actions workflow used for Copilot review setup steps to make MkDocs dependency installation and build verification more reliable by removing reliance on an implicit working directory and by avoiding strict build failures.
Changes:
- Removed the job-level
defaults.run.working-directoryoverride. - Updated MkDocs dependency installation to use an explicit repo-root path (
.github/requirements.txt). - Updated the MkDocs verification step to run a normal build using an explicit config file path (
-f .github/mkdocs.yml) instead of--strict.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - name: Verify MkDocs build | ||
| run: mkdocs build --strict | ||
| run: mkdocs build -f .github/mkdocs.yml |
There was a problem hiding this comment.
@copilot Fix the code for all comments in this review comment.
When a review comment includes a suggested change, apply the suggestion exactly.
Do not make changes beyond what is described in the linked review comment.
There was a problem hiding this comment.
Implemented in commit 8e1812e by setting the Verify MkDocs step to run in ./.github and using mkdocs build -f mkdocs.yml so the config’s relative paths resolve deterministically.
|
One or more custom setup steps configured for this repository failed during this Copilot code review run: Setup steps run before each review. If the review above is missing context, or no review was posted at all, the failing step above may be the cause. See the workflow run for failure details, fix your setup steps configuration, and re-request a review. Note You can configure setup steps for Copilot code review separately from Copilot cloud agent with a |
Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
Copilot code review setup was failing in the
Install MkDocs and extensionsstep, which prevented review runs from initializing reliably. This change makes the setup workflow independent of implicit working-directory behavior and avoids blocking on unrelated pre-existing MkDocs warnings.Setup path resolution
working-directoryoverride from the Copilot setup workflow.MkDocs verification behavior
Resulting workflow shape