From da0488f27e70d9863e0d3927bb63d25a7903d679 Mon Sep 17 00:00:00 2001 From: skyfrk Date: Fri, 27 Sep 2019 12:57:00 +0800 Subject: [PATCH] docs: add section about PUBLISH_REPO --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index e0efe88..184bf2c 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ Table of Contents - [⭐️ `GITHUB_TOKEN`](#%EF%B8%8F-github_token) - [⭐️ Suppressing empty commits](#%EF%B8%8F-suppressing-empty-commits) - [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files) + - [⭐️ Publish to other repository](#%EF%B8%8F-publish-to-other-repository) - [Tips and FAQ](#tips-and-faq) - [How to add `CNAME`](#how-to-add-cname) - [Deployment completed but you cannot read](#deployment-completed-but-you-cannot-read) @@ -217,7 +218,21 @@ For example: keepFiles: true ``` +#### ⭐️ Publish to other repository +By default, the files are published to the respository which is running this action. If you want to publish to another repository on GitHub set the environment variable `PUBLISH_REPO` to `/`. + +For example: + +```yaml +- name: Deploy + uses: peaceiris/actions-gh-pages@v2.4.0 + env: + ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }} + PUBLISH_REPO: peaceiris/peaceiris.github.io + PUBLISH_BRANCH: master + PUBLISH_DIR: ./public +``` ## Tips and FAQ