GitHub Action workflow to preview documentation changes in PRs #112
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
pkalita-lbl
reviewed
Jun 14, 2024
{{cookiecutter.project_name}}/.github/workflows/test_pages_build.yaml
Outdated
Show resolved
Hide resolved
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.
This PR seeks to add a GitHub Action workflow that will run everytime there is a new PR and create a link to preview the docs within that PR. It will also run everytime there is a new commit that is piled on top of commits in the open PR.
One of the pros of having this workflow will be that we won't need to create forks of schema repos just for the purpose of being able to create its own documentation site.
To see an example, you can look at the workflow file in action in the NMDC schema repo: microbiomedata/nmdc-schema#2057
Inspiration from linkml/linkml#2029