From 2948e5eda85d99ffc20cda677353918ea9ea3f45 Mon Sep 17 00:00:00 2001 From: peaceiris <30958501+peaceiris@users.noreply.github.com> Date: Thu, 6 Feb 2020 15:39:37 +0900 Subject: [PATCH] docs: update example of publish_branch --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b63390f..ec04ab0 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ on: - master jobs: - build-deploy: + deploy: runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v1 @@ -186,13 +186,28 @@ The above example is for [Project Pages sites]. (`/` rep For [User and Organization Pages sites] (`/.github.io` repository), we have to set `master` branch to `PUBLISH_BRANCH`. +A default value of `publish_branch` is `gh-pages`. + ```yaml on: push: branches: - source # default branch -publish_branch: master # deploying branch +jobs: + deploy: + runs-on: ubuntu-18.04 + steps: + - uses: actions/checkout@v2 + + - run: somebuild + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} + publish_dir: ./public + publish_branch: master # deploying branch ``` [Project Pages sites]: https://help.github.com/en/articles/user-organization-and-project-pages#project-pages-sites