Skip to content

Conversation

@yguclu
Copy link
Member

@yguclu yguclu commented Mar 6, 2025

Split the workflow into two sequential jobs (build and deploy), which use dedicated GitHub Actions:

  • The build job matrix builds our HTML documentation for GitHub Pages, then it uploads artifacts with job-dependent names using upload-pages-artifact. Hence the generated books can be checked during a PR review. This fixes Provide deploy preview in PRs #12.
  • The deploy job runs on a single platform after the PR is merged. It deploys the correct artifact to GitHub Pages using deploy-pages.

NOTE: We do not need a dedicated branch gh-pages any longer.

Other changes:

  • Rename build-book.yml to build-deploy-book.yml
  • Rename workflow and build jobs
  • Add Contributing section to README.md, which mentions issues, forks, pull requests, workflows, and artifacts.
  • Add myself to AUTHORS.

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`.
@yguclu yguclu changed the title Use actions instead of gh-pages Use actions instead of gh-pages branch Mar 6, 2025
@yguclu yguclu marked this pull request as ready for review March 6, 2025 19:58
@yguclu yguclu requested review from campospinto and kvrigor March 6, 2025 19:58
Copy link

@campospinto campospinto left a 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 ?

@yguclu
Copy link
Member Author

yguclu commented Mar 7, 2025

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

yguclu added 2 commits March 7, 2025 11:11
This mentions issues, forks, pull requests, workflows, and artifacts.
@yguclu yguclu requested a review from campospinto March 7, 2025 11:37
Copy link
Member

@kvrigor kvrigor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Copy link

@campospinto campospinto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@yguclu yguclu merged commit b45beb5 into master Mar 7, 2025
3 checks passed
@yguclu yguclu deleted the yguclu-patch-1 branch March 7, 2025 13:33
yguclu added a commit to yguclu/IGA-Python that referenced this pull request Mar 10, 2025
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.
yguclu added a commit that referenced this pull request Mar 10, 2025
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide deploy preview in PRs

4 participants