GH-327: [Website] Add note about the need to set GitHub Pages deployment source branch to gh-pages when previewing website changes on a fork of apache/arrow-site
#328
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
… setting the Source branch for deployment to GitHub Pages to the `gh-pages` branch when working on a fork of `apache/arrow-site`.
kou
added a commit
that referenced
this pull request
Mar 10, 2023
…version of Node.js and Webpack 5.75.0 (#326) # Overview This pull request modifies the `apache/arrow-site` website deployment workflow (`.github/workflows/deploy.yml`) to use the latest LTS version of Node.js and Webpack 5.75.0 to work around the build issue described in #325. # Qualification To qualify these changes, I: 1. Submitted these changes to the `main` branch of the `mathworks/arrow-site` fork in order to trigger the `gh-pages` deployment workflow. I then selected `gh-pages` as the GitHub Pages deployment branch and verified that the site was deployed as expected to https://mathworks.github.io/arrow-site/. For an example of a successful workflow run, see: https://github.com/mathworks/arrow-site/actions/runs/4313253336/jobs/7524824999. 2. I inspected the GitHub Actions workflow steps to ensure there are no errors. # Future Directions 1. While qualifying with the [fork deployment workflow](https://github.com/apache/arrow-site#deployment), I realized that I needed to [manually change the GitHub Pages deployment branch](https://docs.github.com/en/pages/quickstart) from `asf-site` to `gh-pages` in the "Pages" settings of the `mathworks/arrow-site` fork. This wasn't immediately obvious, and it [isn't listed explicitly as a required step in the README.md](https://github.com/apache/arrow-site#deployment) of `apache/arrow-site`. It would helpful to add an explicit note about this step. I've captured this as #327 and addressed it with PR #328. 2. As described in the "Workarounds" section of the description of #325, there is still more we could choose to do to address the root cause of these build failures (the deprecation of the `md4` hash algorithm in Node 18). This would include setting the `output.hashFunction` to `xxhash64` for Webpack. 3. We could move the workflow into a container to make it easier to reproduce the website build process on a local machine (see the discussion in the comments on this pull request). # Notes 1. Thank you @sgilmore10 for your help with this pull request! 2. Thank you to @avantgardnerio for your suggestion to move the deployment workflow inside of an `ubuntu:latest` container! Closes #325. --------- Co-authored-by: Sarah Gilmore <[email protected]> Co-authored-by: Sutou Kouhei <[email protected]>
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.
Overview
This pull request adds an explicit note to the Deployment section of the README.md about the need to set the GitHub Pages deployment source branch to
gh-pageswhen previewing website changes on a fork ofapache/arrow-site.It isn't immediately obvious that this is a required step. As far as I can tell, the default deployment source branch will normally be set to
asf-sitefor a fork, which means that any changes to the website won't deploy on a successful run. This could potentially be quite confusing.Qualification
N/A
Future Directions
N/A
Notes
N/A
Closes #327