From 9641296c3dbe7196c23d64a90cd7e6fba18247d1 Mon Sep 17 00:00:00 2001 From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com> Date: Mon, 29 Mar 2021 20:29:05 +0900 Subject: [PATCH] docs: Uncomment GHES section --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f8b57b04f..ccccc5e23 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ Note that the `GITHUB_TOKEN` is **NOT** a personal access token. A GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to authenticate in your workflow. So, you can start to deploy immediately without any configuration. + + ## Supported Tokens Three tokens are supported. @@ -43,6 +45,8 @@ Notes: Actually, the `GITHUB_TOKEN` works for deploying to GitHub Pages but it h For the first deployment, we need to select the `gh-pages` branch or another branch on the repository settings tab. See [First Deployment with `GITHUB_TOKEN`](#%EF%B8%8F-first-deployment-with-github_token) + + ## Supported Platforms All Actions runners: Linux (Ubuntu), macOS, and Windows are supported. @@ -57,11 +61,15 @@ All Actions runners: Linux (Ubuntu), macOS, and Windows are supported. 2. WIP, See [Issue #87](https://github.com/peaceiris/actions-gh-pages/issues/87) - +Note that the `GITHUB_TOKEN` that is created by the runner might not inherently have push/publish privileges on GHES. You might need to create/request a technical user with write permissions to your target repository. + + ## Table of Contents