如何利用 GitHub Actions 自动部署你的 Docusaurus 博客到 GitHub Pages
2024-01-08 08:22:53
准备工作
在开始之前,你需要确保你已经满足以下要求:
- 你已经拥有一个 GitHub 账户。
- 你已经安装了 Node.js 和 npm。
- 你已经安装了 Docusaurus CLI。
创建一个新的 Docusaurus 博客
首先,我们需要创建一个新的 Docusaurus 博客。你可以使用以下命令来创建一个新的 Docusaurus 博客:
npx create-docusaurus@latest my-blog
这将在你的当前目录中创建一个名为 my-blog
的新文件夹。
初始化 Git 仓库
接下来,我们需要初始化一个 Git 仓库。你可以使用以下命令来初始化一个 Git 仓库:
cd my-blog
git init
添加文件到 Git 仓库
现在,我们需要将我们的文件添加到 Git 仓库中。你可以使用以下命令来将文件添加到 Git 仓库中:
git add .
提交更改到 Git 仓库
接下来,我们需要将更改提交到 Git 仓库中。你可以使用以下命令来将更改提交到 Git 仓库中:
git commit -m "Initial commit"
创建一个 GitHub 仓库
现在,我们需要创建一个 GitHub 仓库。你可以使用以下步骤来创建一个 GitHub 仓库:
- 登录你的 GitHub 账户。
- 点击右上角的 “+” 按钮。
- 选择 “New repository”。
- 在 “Repository name” 字段中输入你的仓库的名称。
- 在 “Description” 字段中输入你的仓库的。
- 点击 “Create repository” 按钮。
将本地仓库推送到 GitHub 仓库
现在,我们需要将我们的本地仓库推送到 GitHub 仓库中。你可以使用以下命令来将本地仓库推送到 GitHub 仓库中:
git push -u origin main
设置 GitHub Actions
现在,我们需要设置 GitHub Actions。你可以使用以下步骤来设置 GitHub Actions:
-
登录你的 GitHub 账户。
-
导航到你的仓库。
-
点击 “Actions” 选项卡。
-
点击 “New workflow” 按钮。
-
选择 “Set up a workflow yourself” 选项。
-
在 “Workflow name” 字段中输入你的工作流程的名称。
-
在 “On” 字段中选择 “Push”。
-
在 “Jobs” 字段中点击 “Add job”。
-
在 “Job name” 字段中输入你的作业的名称。
-
在 “Steps” 字段中点击 “Add a job”。
-
在 “Step name” 字段中输入你的步骤的名称。
-
在 “Action” 字段中选择 “Actions”。
-
在 “Action name” 字段中输入 “Build and deploy Docusaurus blog”。
-
在 “Inputs” 字段中输入以下值:
- repo_token: 你的 GitHub 个人访问令牌。
- deploy_branch: 你要部署到的分支。
- build_command:
npm run build
。 - deploy_command:
gh-pages -b $DEPLOY_BRANCH
.
-
点击 “Save” 按钮。
测试你的工作流程
现在,你可以测试你的工作流程了。你可以使用以下步骤来测试你的工作流程:
- 推送一些更改到你的仓库中。
- 导航到你的 GitHub 仓库。
- 点击 “Actions” 选项卡。
- 你应该会看到你的工作流程正在运行。
- 一旦工作流程运行完成,你应该会看到你的博客已经部署到了 GitHub Pages。
总结
现在,你已经学会了如何使用 GitHub Actions 自动部署你的 Docusaurus 博客到 GitHub Pages。这将使你能够轻松地将更改推送到你的 GitHub 仓库,并自动在 GitHub Pages 上发布你的博客。