Fix docs workflow root path resolution in generate-docs.sh - #835
Merged
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix failing GitHub Actions job build-and-deploy
Fix docs workflow root path resolution in Jun 26, 2026
generate-docs.sh
mickael-menu
marked this pull request as ready for review
June 26, 2026 14:10
mickael-menu
approved these changes
Jun 26, 2026
mickael-menu
left a comment
Member
There was a problem hiding this comment.
Confirmed it works: https://github.com/readium/swift-toolkit/actions/runs/28242680816
There was a problem hiding this comment.
Pull request overview
This PR fixes the working-directory resolution in scripts/generate-docs.sh so the docs generation job runs from the repository root in GitHub Actions (ensuring Package.swift is found).
Changes:
- Update
PROJECT_ROOTto be the direct parent ofscripts/(instead of two levels up). - Ensure the script
cds into the repository root before performing doc build steps.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
The
build-and-deploydocs job failed becausescripts/generate-docs.shresolved the project root one directory too high in GitHub Actions, soPackage.swiftwas not found. This PR corrects root resolution to match the repository checkout layout used by the workflow.Root cause addressed
PROJECT_ROOTwas derived fromscripts/usingdirname(dirname(...)), which moved outside the repo root in CI.Change
PROJECT_ROOTto the direct parent ofscripts/so the script always runs from the repository root before patching/building docs artifacts.