Introduce a GitHub Actions workflow for publishing the website #16364
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit migrates this functionality away from the bots. Nowadays it's possible to build and deploy the website to GitHub Pages directly through the GitHub Actions, which provides a nice simplication of the process. Not only does this remove the requirement to have a `gh-pages` branch in the repository, it also avoids the complexity of having to configure the workflow to commit to Git branches and allows us to remove the Git committing code from the Gulpfile. Note that deploying directly though GitHub Actions workflows needs to be enabled in the repository settings, but this is easy and well documented on the link below. The following resources are relevant for this patch: - Enabling deployment to GitHub Pages directly through GitHub Actions: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow - Uploading GitHub Pages artifacts example: https://github.com/actions/upload-pages-artifact#usage - Deploying GitHub Pages artifacts example: https://github.com/actions/deploy-pages#usage
Snuffleupagus
approved these changes
Apr 27, 2023
There was a problem hiding this comment.
r=me, this is really nice; thank you!
@calixteman Can you please take care of the steps outlined in #16364 (comment)?
|
All done, except the last step that is for you @timvandermeij ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit migrates this functionality away from the bots. Nowadays it's possible to build and deploy the website to GitHub Pages directly through the GitHub Actions, which provides a nice simplication of the process. Not only does this remove the requirement to have a
gh-pagesbranch in the repository, it also avoids the complexity of having to configure the workflow to commit to Git branches and allows us to remove the Git committing code from the Gulpfile.Note that deploying directly though GitHub Actions workflows needs to be enabled in the repository settings, but this is easy and well documented on the link below.
The following resources are relevant for this patch:
You can view this workflow in action on my fork at https://github.com/timvandermeij/pdf.js/actions/runs/4822609834 where I've done nothing other than enabling GitHub Pages deployment from GitHub Actions workflows in the settings of the fork. The published website can be viewed at https://timvandermeij.github.io/pdf.js.
Implements the first step of #11851 to move the non-testing responsibilities away from the bots.
Relates to mozilla/botio-files-pdfjs#39.
Required actions once this PR is approved:
on_push.jsfile now that publishing the website is moved to GitHub Actions botio-files-pdfjs#39 and deploy it to the bots.gh-pagesbranch automatically).gh-pagesbranch.