Publish storybook to a public github page on every change in components or stories #413
Conversation
|
Please set the following setting in repo settings: Currently gh action config is pointing to this branch, to try it out. |
There was a problem hiding this comment.
Thanks for the hard work on this! Looks good :) just a couple things
Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @Sebastian-ubs)
.github/workflows/storybook.yml line 1 at r1 (raw file):
name: Storybook
I think it would be hard to understand looking at the workflow name what this workflow is doing. Could we change this name and the file name to be a bit more descriptive? Like "Publish Storybook to GitHub Pages" and "publish-storybook.yml" or something?
.github/workflows/storybook.yml line 5 at r1 (raw file):
push: branches: - Sebastian-ubs/issue411
Should this branch name be main?
|
@tjcouch-sil seems it is using the user of the one that triggers the action by pushing. So the branch protection rule needs to be not too strict. |
There was a problem hiding this comment.
It seems mine doesn't work by running npx http-server storybook-static as indicated in this guide to testing the built storybook files locally, but it doesn't look like the same problem. After running npm run storybook:build locally, my
storybook-static/index.html is different than the one in the github-pages branch. My index.html looks nothing like what's pictured, which is github-pages/index.html:
I also have fewer files in my storybook-static than what github-pages has:
I don't know what's going on here, but there must be some environmental difference or something.
Regarding authentication, do you know if JamesIves/[email protected] provides a way to pass in a git auth token or something? I imagine there's probably a way to define secrets in the repo that we can pass into the workflow yml file to get special privileges to push to github-pages even if it's locked.
Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @Sebastian-ubs)
|
Thank you. I recognized it also shows a blank page for me when built locally. Will need to have closer look into it. Yes, |
There was a problem hiding this comment.
I added branch protection on the github-pages branch. Would you mind making some kind of change that triggers it and seeing if it works please? We can figure out authentication if it doesn't work.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @Sebastian-ubs)
|
@tjcouch-sil pushing with my credentials does not work, but we could add an auth token of an allowed automation-user
|
Probably it is because of |
There was a problem hiding this comment.
I added a secret to the github-pages environment that will hopefully allow you to use PAGES_PAT to specify credentials in this workflow. Would you please try using it and let me know how it goes? I found this readme that shows how to use github actions secrets to provide a token (I know it's a different repo, but it looks like the syntax for specifying a token is the same).
Reviewable status: 1 of 2 files reviewed, 2 unresolved discussions (waiting on @Sebastian-ubs)
There was a problem hiding this comment.
Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @Sebastian-ubs)
.github/workflows/storybook.yml line 25 at r4 (raw file):
branch: github-pages folder: storybook-static GITHUB_TOKEN: ${{ secrets.PAGES_PAT }}
I believe this is supposed to be token: ${{ secrets.PAGES_PAT }}. I wonder if this has to do with this job not running. Otherwise I may have messed something up on my end.
There was a problem hiding this comment.
Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @Sebastian-ubs)
.github/workflows/storybook.yml line 25 at r4 (raw file):
Previously, tjcouch-sil (TJ Couch) wrote…
I believe this is supposed to be
token: ${{ secrets.PAGES_PAT }}. I wonder if this has to do with this job not running. Otherwise I may have messed something up on my end.
Hmm looks like it still didn't run. I changed something on my end. Would you mind pushing another fake change to see if the Storybook workflow runs? Thanks!
|
there is goes. well yes you are right we actually told it to only run on a change in components or stories ;-) |
There was a problem hiding this comment.
Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @Sebastian-ubs)
.github/workflows/storybook.yml line 25 at r4 (raw file):
Previously, tjcouch-sil (TJ Couch) wrote…
Hmm looks like it still didn't run. I changed something on my end. Would you mind pushing another fake change to see if the Storybook workflow runs? Thanks!
Looks like it's working again, but we changed multiple things at once. I'm going to change something on my end again. Would you mind making another fake commit please? Thanks!
There was a problem hiding this comment.
Ah I didn't think about the file limitation. Ok gotcha. Do you want to continue this effort or drop it?
Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @Sebastian-ubs)
|
Not quite decided. Maybe let's pause looking into fixing it for now. I can make it a draft PR or anything if the helps anybody |
There was a problem hiding this comment.
Ok gotcha. Looks like the authentication method I provided didn't work :( we'll have to investigate further if we look into this again. Thanks for the hard work!
Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @Sebastian-ubs)
|
@Sebastian-ubs can we close this PR since it hasn't moved for some time? |
|
Yes, we will follow up in paranext/ux#3 based on priority |
Fixes paranext/ux#3
This change is