-
-
Notifications
You must be signed in to change notification settings - Fork 200
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
Issue548 gh pages in master #616
Issue548 gh pages in master #616
Conversation
@jsmailes thank you for this PR! I really appreciate it. Can you please give detailed instructions how I should test this branch? I'm sort of drawing a blank -- I don't typically use git hooks or github actions -- but maybe I should! |
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.
Great work! 👍
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
submodules: recursive |
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.
We don't have any submodules. So, this can be skipped (I guess).
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.
@sobolevn did you test this branch?
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.
Not yet.
Update for @jsmailes - I'll look at this in depth after we get the next release out. |
OK, I've looked this over. The ideal solution, I think, would be to stop using the Is this doable? |
Yes, github can build docs from |
What does this implement/fix? Explain your changes.
Changes the process of building and deploying documentation so
make build-gh-pages
is no longer necessary.The contents of the
gh-pages
branch has been moved to thedocs
folder in themaster
branch.On push to the
master
branch (or when a pull request is merged withmaster
), a GitHub Action is triggered which pushes any changes to thedocs
folder to thegh-pages
branch.This does not change behaviour of the site and does not require any configuration changes, but it improves the repository's usability by getting rid of the need to keep track of two long-live branches.
Does this close any currently open issues?
This closes issues #484 and #548 by unifying the
gh-pages
andmaster
branches and automating updates of the site based on changes to themaster
branch.Any relevant logs, error output, etc?
(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)
Any other comments?
It may be possible to make this change using Travis instead of GitHub Actions if desired.
I am more familiar with GitHub Actions so that's what I've used here, but I imagine it would be possible to get the same results with a Travis configuration file.