diff --git a/README.md b/README.md index c3b9615..0720e2c 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ Three tokens are supported. | `deploy_key` | ✅️ | ✅️ | SSH | Necessary | | `personal_token` | ✅️ | ✅️ | HTTPS | Necessary | +Notes: Actually, the `GitHub_TOKEN` works for deploying to GitHub Pages but it has still some limitations. For the first deployment, we need to select the `gh-pages` branch or `master` branch on the repository settings tab. See [First Deployment with `GITHUB_TOKEN`](#%EF%B8%8F-first-deployment-with-github_token) + ### Supported Platforms | runs-on | `github_token` | `deploy_key` | `personal_token` | @@ -77,6 +79,7 @@ Three tokens are supported. - [⭐️ Create Git tag](#%EF%B8%8F-create-git-tag) - [Tips and FAQ](#tips-and-faq) - [⭐️ Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key) + - [⭐️ First Deployment with `GITHUB_TOKEN`](#%EF%B8%8F-first-deployment-with-github_token) - [⭐️ Use the latest and specific release](#%EF%B8%8F-use-the-latest-and-specific-release) - [Examples](#examples) - [⭐️ Static Site Generators with Node.js](#%EF%B8%8F-static-site-generators-with-nodejs) @@ -140,13 +143,9 @@ jobs: The above example is for [Project Pages sites]. (`/` repository) -| Actions log overview | Build step log | +| Actions log overview | GitHub Pages log | |---|---| -| ![](./images/log1.jpg) | ![](./images/log2.jpg) | - -| Deploy step log | GitHub Pages log | -|---|---| -| ![](./images/log3.jpg) | ![](./images/log4.jpg) | +| ![](./images/log_overview.jpg) | ![](./images/log_success.jpg) | ### ⭐️ Repository type - User and Organization @@ -193,7 +192,7 @@ jobs: ### ⭐️ `deploy_key` -Read [⭐️ Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH deploy key, and set the `deploy_key` option like the following. +Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH deploy key, and set the `deploy_key` option like the following. ```yaml - name: Deploy @@ -431,6 +430,18 @@ Next, Go to **Repository Settings** |---|---| | ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) | +### ⭐️ First Deployment with `GITHUB_TOKEN` + +The `GITHUB_TOKEN` has limitations for the first deployment so we have to select the GitHub Pages branch on the repository settings tab. + +| First deployment failed | Go to the settings tab | +|---|---| +| ![](./images/log_first_deployment_failed_with_github_token.jpg) | ![](./images/settings_inactive.jpg) | + +| Select branch | Deploying again and succeed | +|---|---| +| ![](./images/settings_select.jpg) | ![](./images/log_success.jpg) | + ### ⭐️ Use the latest and specific release We recommend you to use the latest and specific release of this action for stable CI/CD. diff --git a/images/log2.jpg b/images/log2.jpg deleted file mode 100644 index 2b53a6e..0000000 Binary files a/images/log2.jpg and /dev/null differ diff --git a/images/log3.jpg b/images/log3.jpg deleted file mode 100644 index fd465bc..0000000 Binary files a/images/log3.jpg and /dev/null differ diff --git a/images/log_first_deployment_failed_with_github_token.jpg b/images/log_first_deployment_failed_with_github_token.jpg new file mode 100644 index 0000000..256cbd4 Binary files /dev/null and b/images/log_first_deployment_failed_with_github_token.jpg differ diff --git a/images/log_overview.jpg b/images/log_overview.jpg new file mode 100644 index 0000000..5ac659d Binary files /dev/null and b/images/log_overview.jpg differ diff --git a/images/log_success.jpg b/images/log_success.jpg new file mode 100644 index 0000000..5da8613 Binary files /dev/null and b/images/log_success.jpg differ diff --git a/images/settings_inactive.jpg b/images/settings_inactive.jpg new file mode 100644 index 0000000..c6933fe Binary files /dev/null and b/images/settings_inactive.jpg differ diff --git a/images/settings_select.jpg b/images/settings_select.jpg new file mode 100644 index 0000000..a1e9576 Binary files /dev/null and b/images/settings_select.jpg differ