Skip to content

Commit

Permalink
docs: enhance explanation for EXTERNAL_REPOSITORY
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Sep 27, 2019
1 parent 954d420 commit 2485261
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ For example:

#### ⭐️ Deploy to external 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 `EXTERNAL_REPOSITORY` to `<username>/<repo>`.
By default, your files are published to the repository which is running this action. If you want to publish to another repository on GitHub, set the environment variable `EXTERNAL_REPOSITORY` to `<username>/<external-repository>`.

For example:

Expand All @@ -229,11 +229,17 @@ For example:
uses: peaceiris/[email protected]
env:
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
EXTERNAL_REPOSITORY: peaceiris/peaceiris.github.io
EXTERNAL_REPOSITORY: username/username.github.io
PUBLISH_BRANCH: master
PUBLISH_DIR: ./public
```

You can use `ACTIONS_DEPLOY_KEY` or `PERSONAL_TOKEN`. When you use `ACTIONS_DEPLOY_KEY`, set your private key to the repository which includes this action and set your public key to your external repository.

Be careful, `GITHUB_TOKEN` has no permission to access to external repositories.



## Tips and FAQ

### How to add `CNAME`
Expand Down

0 comments on commit 2485261

Please sign in to comment.