-
Notifications
You must be signed in to change notification settings - Fork 907
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
Publish GitHub Pages previews on every PR #3601
Publish GitHub Pages previews on every PR #3601
Conversation
BundleMonUnchanged files (125)
No change in files bundle size Final result: ✅ View report in BundleMon website ➡️ |
c26a6a6
to
080dcbd
Compare
|
877c695
to
db2f116
Compare
db2f116
to
c0a3199
Compare
A preview of the GitHub Pages site based on this PR is now available here: |
c0a3199
to
38e8d3a
Compare
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! This took a while to understand, but makes sense
The only thing I'm not sure about is whether we want to build this /v1.x
path on every preview, but I figure not doing that probably just makes things more complicated for little gain?
include-hidden-files: true | ||
name: ghpages-deploy-artifacts | ||
path: .ghpages-deploy | ||
retention-days: 1 |
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.
Is this going to delete the preview if it's not reviewed within 1 day? I guess we could just run the job again, but is there a downside to making this a bit longer?
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.
Because all of these CI workflows are stateless, the way that they assemble the GitHub Pages site is by uploading them to a temporary ‘artifacts cache’ that only needs to live for the duration of the CI run. 1 day is actually too long.
inputs: | ||
pr-number: | ||
type: number | ||
repository: | ||
default: 'solana-web3.js' | ||
type: string |
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.
I think it'd be useful to add a comment here that the inputs are only used for the REACT_EXAMPLE_APP_BASE_PATH
and therefore for new web3js
It took me a while to figure out what's going on when the legacy job calls this without any inputs
- uses: actions/upload-artifact@v4 | ||
with: | ||
include-hidden-files: true | ||
name: ghpages-deploy-artifacts | ||
path: .ghpages-deploy |
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.
Probably just me not knowing stuff, but I'd find a comment here useful that this is uploading for a later deploy to github-pages. Rather than actions/upload-artifact
actually being an upload to github pages which is what I first thought was going on.
Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up. |
Now, every time workflows are run on a PR:
solana-labs.github.io/solana-web3.js-pr-preview/{PR_NUMBER}/
This will make it much easier for reviewers to review changes that affect either the example app or the documentation websites.