使用GitHub Actions部署Storybook到GitHub Pages的异常问题
我正尝试通过GitHub Actions将Storybook部署到GitHub Pages。
此前我参考了大量教程以及Stack Overflow相关解答,在阅读GitHub Pages官方文档后多次调整yml配置文件,但始终没有部署成功。
每次尝试构建部署时,要么部署流程直接失败;要么构建成功(即使用下文列出的第二个yml配置时),项目内容也无法正常展示在对应的GitHub Pages访问地址上。我推测大概率是yml配置存在待调整的问题,但始终没有找到能让Storybook在仓库的GitHub Pages地址上正常渲染运行的解决方案;本地执行npm脚本构建Storybook是完全正常的。
我的yml配置是否存在遗漏?我已经为当前使用的仓库完成了GitHub Pages的基础配置。
我的package.json配置如下:
{ "homepage": "http://<我的 GitHub 用户名>.github.io/<我的仓库名>", "name": "repo-name", "version": "0.1.0", "private": false, "license": "MIT", "dependencies": { "@testing-library/jest-dom": "^5.11.8", "@testing-library/react": "^11.2.3", "@testing-library/user-event": "^12.6.0", "babel-loader": "^8.2.2", "feather-icons": "^4.28.0", "react": "^17.0.1", "react-dom": "^17.0.1", "react-feather": "^2.0.9", "react-scripts": "4.0.1", "web-vitals": "^0.2.4" }, "scripts": { "start": "react-scripts start", "build": "react-scripts build", "test": "react-scripts test", "eject": "react-scripts eject", "storybook": "start-storybook -s public", "build-storybook": "build-storybook -o docs-build", "deploy-storybook": "gh-pages -d docs" }, "eslintConfig": { "extends": [ "react-app", "react-app/jest" ] }, "browserslist": { "production": [ ">0.2%", "not dead", "not op_mini all" ], "development": [ "last 1 chrome version", "last 1 firefox version", "last 1 safari version" ] }, "devDependencies": { "@storybook/addon-actions": "^6.1.11", "@storybook/addon-controls": "^6.1.11", "@storybook/addon-essentials": "^6.1.21", "@storybook/addon-knobs": "^6.1.12", "@storybook/addon-links": "^6.1.11", "@storybook/addon-storyshots": "^6.1.21", "@storybook/node-logger": "^6.1.11", "@storybook/preset-create-react-app": "^3.1.5", "@storybook/react": "^6.1.21", "gh-pages": "^3.1.0", "react-test-renderer": "^17.0.1" } }
我尝试过的两种yml配置及对应运行结果
第一种yml配置
构建失败,出现以下报错:
fatal: could not read Username for 'https://github.com': No such device or address
name: Build and Deploy on: push: paths: ["stories/**", "src/components/**"] # 仅当上述目录的文件变更时触发工作流 jobs: build-and-deploy: runs-on: ubuntu-latest steps: - name: Checkout 🛎️ uses: actions/checkout@main - name: Build Storybook run: | # 安装npm依赖并构建Storybook文件 npm install npm run build-storybook - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@4.1.0 with: token: ${{ secrets.GITHUB_TOKEN }} branch: storybook-static # 工作流要部署到的分支 folder: docs-build # build-storybook脚本生成文件的目录 target-folder: docs # 用于提供Storybook文件服务的目录
第二种yml配置
构建成功,但访问对应GitHub Pages地址时,预期展示Storybook的位置返回404错误。
name: Build and Deploy on: push: paths: ["stories/**", "src/components/**"] # 仅当上述目录的文件变更时触发工作流 jobs: build-and-deploy: runs-on: ubuntu-latest steps: - name: Checkout 🛎️ uses: actions/checkout@main - name: Build Storybook run: | # 安装npm依赖并构建Storybook文件 npm install npm run build-storybook - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@4.1.0 with: token: ${{ secrets.GITHUB_TOKEN }} branch: storybook-static # 工作流要部署到的分支 folder: docs-build # build-storybook脚本生成文件的目录 target-folder: docs # 用于提供Storybook文件服务的目录 - name: Deploy storybook run: | npm run deploy-storybook
我此前参考的教程与文档包括:
- 《如何将Storybook部署到GitHub Pages》
- GitHub Actions相关文档
内容的提问来源于stack exchange,提问作者brad。
相关产品推荐
相关产品推荐

