Skip to content

Stabilize Copilot review setup for MkDocs installs and builds - #313

Merged
TaylerUva merged 3 commits into
mainfrom
copilot/fix-setup-steps-failure
Aug 16, 2026
Merged

Stabilize Copilot review setup for MkDocs installs and builds#313
TaylerUva merged 3 commits into
mainfrom
copilot/fix-setup-steps-failure

Conversation

Copilot AI commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Copilot code review setup was failing in the Install MkDocs and extensions step, 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

    • Remove the job-level working-directory override from the Copilot setup workflow.
    • Use explicit repo-root paths for both dependency installation and MkDocs config loading.
  • MkDocs verification behavior

    • Change the setup-time MkDocs verification from strict mode to a normal build so existing documentation warnings do not fail Copilot review initialization.
  • Resulting workflow shape

    - name: Install MkDocs and extensions
      run: pip install -r .github/requirements.txt
    
    - name: Verify MkDocs build
      run: mkdocs build -f .github/mkdocs.yml

Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix custom setup steps for Copilot code review Stabilize Copilot review setup for MkDocs installs and builds Aug 16, 2026
Copilot AI requested a review from TaylerUva August 16, 2026 01:01
@TaylerUva
TaylerUva requested a lite review from Copilot and removed request for TaylerUva August 16, 2026 01:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-directory override.
  • 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.

Comment on lines +22 to +23
- name: Verify MkDocs build
run: mkdocs build --strict
run: mkdocs build -f .github/mkdocs.yml

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot AI commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

One or more custom setup steps configured for this repository failed during this Copilot code review run:

Install MkDocs and extensions

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 copilot-code-review.yml file. Read the docs for details.

Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
Copilot AI requested a review from TaylerUva August 16, 2026 01:38
@TaylerUva
TaylerUva marked this pull request as ready for review August 16, 2026 01:39
@TaylerUva
TaylerUva merged commit ff6a6fe into main Aug 16, 2026
@TaylerUva
TaylerUva deleted the copilot/fix-setup-steps-failure branch August 16, 2026 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

One or more custom setup steps configured for this repository failed during this Copilot code review run:

3 participants