docs: allow publishing docs from forked PRs #327
Merged
Conversation
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
Fixes issues with race conditions by enabling folder cleaning Requires maintainer approval via an environment. Adapt workflows to correctly handle pull_request_target by explicitly checking out the correct repository. Flattened folder structure gh-pages/ ................. │─ pr-42/ # PR eclipse-score#42 preview │─ pr-99/ # PR eclipse-score#99 preview │─ feature-x/ # Feature branch preview │─ v17/ # Tagged release │─ main/ # main branch (alternatively "latest") In addition to this repo, there are a couple more changes that are needed: - the otterdog repo has to be updated and add the proper maintainers to the github-pages env - the eclipse-score.github.io repo has to be updated so that the Docs refrences the /main folder by default closes eclipse-score#168 eclipse-score#194 eclipse-score#269 Signed-off-by: Dan Calavrezo <dan.calavrezo.ext@qorix.ai>
Signed-off-by: Dan Calavrezo <dan.calavrezo.ext@qorix.ai>
Member
AlexanderLanin
left a comment
AlexanderLanin
left a comment
There was a problem hiding this comment.
Sorry, even more questions
AlexanderLanin
added
community:infrastructure
Addressed PR comments. - use base action when performing deployment - added extra comments Signed-off-by: Dan Calavrezo <dan.calavrezo.ext@qorix.ai>
Signed-off-by: Dan Calavrezo <dan.calavrezo.ext@qorix.ai>
Contributor
Author
No worries, they are very helpful and improved the PR. |
.github/workflows/docs.yml
Outdated
| cancel-in-progress: false | ||
| runs-on: ubuntu-latest | ||
| needs: docs-build | ||
| environment: github-pages # Requires approval before execution |
Member
There was a problem hiding this comment.
I just noticed the entire idea / concept should be documented somewhere. (separate PR, so we can get this one finally merged)
Signed-off-by: Dan Calavrezo <dan.calavrezo.ext@qorix.ai>
AlexanderLanin
previously approved these changes
Feb 11, 2025
Member
|
open points:
|
Since we execute the action from the base repo, we don't need maintainers to trigger the workflow executions. Signed-off-by: Dan Calavrezo <dan.calavrezo.ext@qorix.ai>
dcalavrezo-qorix
force-pushed
the
dcalavrezo_docs_pr_preview
branch
from
7a4db79 to
5e5a1ed
Compare
Member
|
Contributor
Author
Yes, a /main folder will be created after the merge the |
AlexanderLanin
approved these changes
Feb 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes issues with race conditions by enabling folder cleaning
Requires maintainer approval via an environment.
Adapt workflows to correctly handle pull_request_target by explicitly checking out the correct repository.
Flattened folder structure
gh-pages/
.................
│─ pr-42/ # PR #42 preview
│─ pr-99/ # PR #99 preview
│─ feature-x/ # Feature branch preview
│─ v17/ # Tagged release
│─ main/ # main branch (alternatively "latest")
In addition to this repo, there are a couple more changes that are needed:
closes #168 #194 #269