ci: forks push the docs to branch gh-pages #920
Merged
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
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.
Currently, documentation is only published when CI is run in this repo. That's because it's pushed to repo VUnit/vunit.github.io, which forks do not have write access to.
However, forks can use branch
gh-pagesto have docs published atuser.github.io/vunit.That allows contributors to see changes to the docs using CI, instead of downloading the artifact or building the docs locally.
This PR supports both use cases. In this repo, the secret SSH key is used for updating vunit.github.io. In forks, branch gh-pages is updated using the default token.