-
-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update GH Pages setup example to include the latest actions version #27061
base: next
Are you sure you want to change the base?
Conversation
This adds the latest version of the deploy action, as the older version was failing. It also adds an optional task to install Yarn Modern, if a repo requires it.
@jonniebigodes checking in as I haven't heard any updates in 2 weeks, do you need me to make any changes to help get this checked in? It's a simple doc change |
@esimkowitz, sorry for the radio silence; I was otherwise engaged with other documentation issues that required my immediate attention and left this pull request without a review. If you're ok with it, I'll take a look at it next week and follow up with you on any feedback that may be required. Sounds good to you? Have a great day. Stay safe |
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.
@esimkowitz, once again, I'm sorry for the delayed response. I left a small item for you to look into when you can. Also, if you want, you can check the suggestion enabled here.
Let me know, and we'll go from there.
Looking forward to hearing from you.
Have a fantastic rest of your weekend.
Stay safe
node-version: '20.x' | ||
|
||
# If using Yarn Modern, you also need to add the following action to install your configured Yarn version: | ||
# - name: Install Yarn | ||
# run: corepack enable && yarn install |
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.
@esimkowitz If you're ok with it, could you move the Corepack step above? Before the node setup action, turning it into something as follows:
name: "Build and Publish Storybook to GitHub Pages"
on:
push:
branches:
- 'your-branch-name' # Replace with the branch you want to deploy from
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
# Enable the steps below if you're working with Corepack's supported package managers (e.g. Yarn 2+, pnpm)
#- name: Enable Corepack
# run: corepack enable
- uses: actions/setup-node@v4
with:
node-version: 20
- run: yarn install
- uses: bitovi/github-actions-storybook-to-github-pages@v1.0.3
with:
install_command: yarn install # default: npm ci
build_command: yarn build-storybook # default: npm run build-storybook
path: storybook-static # default: dist/storybook
checkout: false # default: true
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 corepack is bundled with Nodejs, I haven't tested if it's available before NodeJS gets installed
What I did
This adds the latest version of the GH Pages deploy action, as the older version was failing. It also adds an optional task to install Yarn Modern, if a repo requires it.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.馃 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>