-
Notifications
You must be signed in to change notification settings - Fork 9
Use actions instead of gh-pages branch #13
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
Conversation
Split workflow into two sequential jobs (`build_book` and `deploy_book`), which use dedicated GitHub Actions: - `build_book` uses `configure-pages` and `upload-pages-artifact`; - `deploy_book` uses `deploy-pages`.
Also rename the names of the workflow and the build jobs
campospinto
left a comment
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.
Thanks Yaman!
Do you think we should add two lines on a "Contributing" section of the readme, to tell/explain how to review the book during a PR review ?
Good idea! I'll do that |
This mentions issues, forks, pull requests, workflows, and artifacts.
kvrigor
left a comment
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.
Looks good!
campospinto
left a comment
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.
Thanks!
After PR pyccel#13 the deploy step of our workflows did not have the necessary permissions to upload our website to GitHub Pages. This should fix it.
After PR #13 the deploy step of our workflows did not have the necessary permissions to upload our website to GitHub Pages. This change fixes it.
Split the workflow into two sequential jobs (
buildanddeploy), which use dedicated GitHub Actions:buildjob matrix builds our HTML documentation for GitHub Pages, then it uploads artifacts with job-dependent names usingupload-pages-artifact. Hence the generated books can be checked during a PR review. This fixes Provide deploy preview in PRs #12.deployjob runs on a single platform after the PR is merged. It deploys the correct artifact to GitHub Pages usingdeploy-pages.NOTE: We do not need a dedicated branch
gh-pagesany longer.Other changes:
build-book.ymltobuild-deploy-book.ymlContributingsection toREADME.md, which mentions issues, forks, pull requests, workflows, and artifacts.AUTHORS.