-
Notifications
You must be signed in to change notification settings - Fork 346
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Start pushing tags to permanently-kept documentation pages #4778
base: master
Are you sure you want to change the base?
Start pushing tags to permanently-kept documentation pages #4778
Conversation
@GarethCabournDavies I think this is a long overdue good thing to do. Thank you for looking into this! |
I think the only way this can be tested is it it is just merged and see if it runs for the next release |
.github/workflows/basic-tests.yml
Outdated
@@ -75,3 +75,23 @@ jobs: | |||
BRANCH: gh-pages | |||
FOLDER: _gh-pages | |||
SINGLE_COMMIT: true | |||
deploy_documentation_release: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GarethCabournDavies Doesn't this have code duplication here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To further explain, it looks like the documentation release is now duplicated rather than simply running on both master and the tag version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, I couldnt work out how to move to latest _gh-pages/${GITHUB_REF#refs/tags/}
or current
(or whatever) dynamically
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GarethCabournDavies I don't really follow. Wouldn't you just have an if statement in the yaml in the case of a release and then essentially do what you do here, except without all the duplicated bits?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I think I didn't realise you can effectively use shell if statements in the yaml, I will try deduplicating
38da3dc
to
ee9c130
Compare
Here I am starting to put together an idea on how to provide documentation for every release. I.e. instead of only having https://pycbc.org/pycbc/latest/html/, we would have https://pycbc.org/pycbc/v2.4.X/html/ as well, which points to the documentation at that release
Standard information about the request
This change affects continuous integration and the documentation
This change has been proposed using the contribution guidelines
This change will require a new release to ensure that it is correctly enacted
Motivation
This is best practice anyway, but there is an issue at #2504
Contents
Plan for next steps
Testing performed
I'm not sure how to test this without making a release!