docs: preview in PRs #96
Draft
Conversation
This file contains 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
ltekieli
reviewed
Dec 17, 2024
ltekieli
reviewed
Dec 17, 2024
ltekieli
reviewed
Dec 17, 2024
|
gh pages generation is set to workflow currently: |
FScholPer
previously approved these changes
Dec 17, 2024
I guess I'll change this PR to try uploading both ways. |
AlexanderLanin
had a problem deploying
to
github-pages
GitHub Actions
Failure
|
This is quite ugly, I will split cleanup into a separate workflow, so it doesn't show up here. |
AlexanderLanin
force-pushed
the
pr-previews
branch
from
d038726 to
21b92d0
Compare
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.
Current State
Documentation is built during PRs, and currently, an artifact is uploaded, with a link to the artifact added to the PR. However, this generates numerous links (e.g., see #94), and to view the documentation, users must download and extract the artifact manually.
Desired State
Provide a direct link to the documentation preview in PRs. This link should allow users to preview the documentation directly, without extra steps, and remain stable throughout the PR's lifetime, unaffected by new commits.
Solution
Since GitHub Pages supports only a single folder or artifact per repository, and rebuilding all versions of documentation for every PR is inefficient, a new approach is needed. The gh-pages branch will act as persistent storage for documentation artifacts. Each PR will store its specific documentation in a dedicated subfolder within this branch.
When a PR is updated, the workflow will add or update the corresponding documentation in its designated subfolder. Once the PR is closed or merged, its documentation subfolder will be removed to keep the branch manageable. This approach ensures stable links, efficient builds, and clear documentation previews.
This probably belongs to #78. And it closes #94.