From b1e72dce0ea19dc527a4f7a79ff1458e4d6e7cc8 Mon Sep 17 00:00:00 2001 From: jenkey2011 Date: Wed, 12 Feb 2020 17:36:11 +0800 Subject: [PATCH 1/8] docs: add a method to deploy vuepress site with github actions --- packages/docs/docs/guide/deploy.md | 29 +++++++++++++++++++++++++++ packages/docs/docs/zh/guide/deploy.md | 29 +++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md index e5ae90df6f..acccfd8be5 100644 --- a/packages/docs/docs/guide/deploy.md +++ b/packages/docs/docs/guide/deploy.md @@ -56,6 +56,35 @@ cd - You can also run the above script in your CI setup to enable automatic deployment on each push. ::: +### GitHub Pages and GitHub Actions + +1. Create a personal access token +2. Create encrypted secrets under your repository +3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. E.g:`vuepress-deploy.yml`; + +```yml +name: Build and Deploy +on: [push] +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + + - name: vuepress-deploy + uses: jenkey2011/vuepress-deploy@master + env: + ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} + TARGET_REPO: username/repo + TARGET_BRANCH: master + BUILD_SCRIPT: yarn && yarn build + BUILD_DIR: docs/.vuepress/dist + CNAME: https://www.xxx.com +``` + +For more information, you can see [jenkey2011/vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy/) + ### GitHub Pages and Travis CI 1. Set correct `base` in `docs/.vuepress/config.js`. diff --git a/packages/docs/docs/zh/guide/deploy.md b/packages/docs/docs/zh/guide/deploy.md index bc8c439a85..61383f6df8 100644 --- a/packages/docs/docs/zh/guide/deploy.md +++ b/packages/docs/docs/zh/guide/deploy.md @@ -56,6 +56,35 @@ cd - 你可以在你的持续集成的设置中，设置在每次 push 代码时自动运行上述脚本。 ::: +### GitHub Pages and Github Actions + +1. 创建 `Github access token` +2. 在你github仓库下，创建一个 `secrets` ，填入刚创建的 `token` +3. 在项目根目录下的`.github/workflows`目录（没有的话，请手动创建一个）下创建一个 `.yml` 或者 `.yaml` 文件，如:`vuepress-deploy.yml`; + +```yml +name: Build and Deploy +on: [push] +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + + - name: vuepress-deploy + uses: jenkey2011/vuepress-deploy@master + env: + ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} + TARGET_REPO: username/repo + TARGET_BRANCH: master + BUILD_SCRIPT: yarn && yarn build + BUILD_DIR: docs/.vuepress/dist + CNAME: https://www.xxx.com +``` + +详细使用方法，可以看[jenkey2011/vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy/) + ### GitHub Pages and Travis CI 1. 在 `docs/.vuepress/config.js` 中设置正确的 `base`。 From 51271b7c4d5dd8a4952fa3297b8797ff34d81b7b Mon Sep 17 00:00:00 2001 From: ULIVZ <472590061@qq.com> Date: Tue, 21 Dec 2021 01:22:25 +0800 Subject: [PATCH 2/8] chore: tweaks --- packages/docs/docs/zh/guide/deploy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/docs/docs/zh/guide/deploy.md b/packages/docs/docs/zh/guide/deploy.md index 61383f6df8..b8f63f366f 100644 --- a/packages/docs/docs/zh/guide/deploy.md +++ b/packages/docs/docs/zh/guide/deploy.md @@ -59,8 +59,8 @@ cd - ### GitHub Pages and Github Actions 1. 创建 `Github access token` -2. 在你github仓库下，创建一个 `secrets` ，填入刚创建的 `token` -3. 在项目根目录下的`.github/workflows`目录（没有的话，请手动创建一个）下创建一个 `.yml` 或者 `.yaml` 文件，如:`vuepress-deploy.yml`; +2. 在你 github 仓库下，创建一个 `secrets` ，填入刚创建的 `token` +3. 在项目根目录下的 `.github/workflows` 目录（没有的话，请手动创建一个）下创建一个 `.yml` 或者 `.yaml` 文件，如:`vuepress-deploy.yml`; ```yml name: Build and Deploy From 61dd8094772e0e9f46156db9f855aeaa7c118adc Mon Sep 17 00:00:00 2001 From: ULIVZ <472590061@qq.com> Date: Tue, 21 Dec 2021 01:23:36 +0800 Subject: [PATCH 3/8] chore: tweaks --- packages/docs/docs/guide/deploy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md index acccfd8be5..c968fc7f67 100644 --- a/packages/docs/docs/guide/deploy.md +++ b/packages/docs/docs/guide/deploy.md @@ -58,9 +58,9 @@ You can also run the above script in your CI setup to enable automatic deploymen ### GitHub Pages and GitHub Actions -1. Create a personal access token -2. Create encrypted secrets under your repository -3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. E.g:`vuepress-deploy.yml`; +1. Create a personal access token; +2. Create encrypted secrets under your repository; +3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. e.g:`vuepress-deploy.yml`: ```yml name: Build and Deploy From 9b09ac9eb1f8fd182dc03231a589be500d4b4217 Mon Sep 17 00:00:00 2001 From: ULIVZ <472590061@qq.com> Date: Tue, 21 Dec 2021 01:24:24 +0800 Subject: [PATCH 4/8] chore: tweaks --- packages/docs/docs/guide/deploy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md index c968fc7f67..1914268f86 100644 --- a/packages/docs/docs/guide/deploy.md +++ b/packages/docs/docs/guide/deploy.md @@ -83,7 +83,7 @@ jobs: CNAME: https://www.xxx.com ``` -For more information, you can see [jenkey2011/vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy/) +For more information, you can checkout [jenkey2011/vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy/). ### GitHub Pages and Travis CI From 7a10fceeedd08b826da42939eba265c4b47e30d5 Mon Sep 17 00:00:00 2001 From: ULIVZ <472590061@qq.com> Date: Tue, 21 Dec 2021 01:25:34 +0800 Subject: [PATCH 5/8] chore: add link --- packages/docs/docs/guide/deploy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md index 1914268f86..23bf7d450d 100644 --- a/packages/docs/docs/guide/deploy.md +++ b/packages/docs/docs/guide/deploy.md @@ -58,7 +58,7 @@ You can also run the above script in your CI setup to enable automatic deploymen ### GitHub Pages and GitHub Actions -1. Create a personal access token; +1. [Create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token); 2. Create encrypted secrets under your repository; 3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. e.g:`vuepress-deploy.yml`: From e334405cce483ac4344b88f85046696bb50dc691 Mon Sep 17 00:00:00 2001 From: ULIVZ <472590061@qq.com> Date: Tue, 21 Dec 2021 01:25:50 +0800 Subject: [PATCH 6/8] chore: add link From 5781976d639db495e660ab2cfb4b1dde34bf390f Mon Sep 17 00:00:00 2001 From: ULIVZ <472590061@qq.com> Date: Tue, 21 Dec 2021 01:26:42 +0800 Subject: [PATCH 7/8] chore: add link --- packages/docs/docs/guide/deploy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md index 23bf7d450d..b0d598be39 100644 --- a/packages/docs/docs/guide/deploy.md +++ b/packages/docs/docs/guide/deploy.md @@ -59,7 +59,7 @@ You can also run the above script in your CI setup to enable automatic deploymen ### GitHub Pages and GitHub Actions 1. [Create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token); -2. Create encrypted secrets under your repository; +2. Create [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) under your repository; 3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. e.g:`vuepress-deploy.yml`: ```yml From 842f6312975295da4363754a76bf79eaa491207f Mon Sep 17 00:00:00 2001 From: ULIVZ <472590061@qq.com> Date: Tue, 21 Dec 2021 01:27:45 +0800 Subject: [PATCH 8/8] chore: add cn doc --- packages/docs/docs/zh/guide/deploy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/docs/docs/zh/guide/deploy.md b/packages/docs/docs/zh/guide/deploy.md index b8f63f366f..2386ab96d5 100644 --- a/packages/docs/docs/zh/guide/deploy.md +++ b/packages/docs/docs/zh/guide/deploy.md @@ -58,8 +58,8 @@ cd - ### GitHub Pages and Github Actions -1. 创建 `Github access token` -2. 在你 github 仓库下，创建一个 `secrets` ，填入刚创建的 `token` +1. 创建 [Github access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token); +2. 在你 github 仓库下，创建一个 [secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) ，填入刚创建的 `token` 3. 在项目根目录下的 `.github/workflows` 目录（没有的话，请手动创建一个）下创建一个 `.yml` 或者 `.yaml` 文件，如:`vuepress-deploy.yml`; ```yml