Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[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 #327

Closed
kevingurney opened this issue Mar 2, 2023 · 1 comment · Fixed by #328
Closed

[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 #327

kevingurney opened this issue Mar 2, 2023 · 1 comment · Fixed by #328

Comments

@kevingurney
Copy link
Member

Describe the bug, including details regarding any error messages, version, and platform.

This is a follow up to this comment.

It would be helpful to add an explicit note to the Deployment section of the README.md about the need to set the GitHub Pages deployment source branch to gh-pages when previewing website changes on a fork of apache/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-site for a fork, which means that any changes to the website won't deploy on a successful run. This could potentially be quite confusing.

Component(s)

Website
@kevingurney
Copy link
Member Author

take

@kevingurney kevingurney changed the title [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` [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 Mar 2, 2023
This was referenced Mar 2, 2023
Merged
Merged
@kou kou closed this as completed in #328 Mar 2, 2023
kou pushed a commit that referenced this issue Mar 2, 2023
@kevingurney
GH-327: [Website] Add note about the need to set GitHub Pages deploym…
8f870fc 
…ent source branch to `gh-pages` when previewing website changes on a fork of `apache/arrow-site` (#328)

# Overview

This pull request adds an explicit note to the [Deployment section of
the
README.md](https://github.com/apache/arrow-site/blob/main/README.md#deployment)
about the need to [set the GitHub Pages deployment source
branch](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch)
to `gh-pages` when previewing website changes on a fork of
`apache/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-site` for 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
kou added a commit that referenced this issue Mar 10, 2023
@kevingurney @sgilmore10 @kou
GH-325: [Website] Update website deployment script to use latest LTS …
b955d79 
…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 <sgilmore@mathworks.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@kevingurney