Deploy develop branch documentation to /develop subpath #1220
+16
−5
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.
Description
Updates the merge workflow to deploy the documentation to the
/developsubpath when when merging PRs into thedevelopbranch and to deploy docs to/when merging to themasterbranch. This will have the behavior of having the current docs site being updated less frequently and will only reflect the current state of the master branch.Verification
I created a repo mimicking the setup of the deploy action we use for Basilisk for testing at https://github.com/ReeceHumphreys/deploy-test:
index.rstin thedevelopbranch.index.rstin themainbranch.Caution
I will delete the repo mentioned in the Verification section when this PR is merged so the link may break.
Documentation
N/A
Future work
We could theoretically maintain documentation for each major release using this strategy. So we could have /3.8, 3.9, etc.
This would require keeping extra branches around though which we probably don't want to do.