Skip to content

Commit 2485261

Browse files
committed
docs: enhance explanation for EXTERNAL_REPOSITORY
1 parent 954d420 commit 2485261

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ For example:
220220

221221
#### ⭐️ Deploy to external repository
222222

223-
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>`.
223+
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>`.
224224

225225
For example:
226226

@@ -229,11 +229,17 @@ For example:
229229
uses: peaceiris/[email protected]
230230
env:
231231
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
232-
EXTERNAL_REPOSITORY: peaceiris/peaceiris.github.io
232+
EXTERNAL_REPOSITORY: username/username.github.io
233233
PUBLISH_BRANCH: master
234234
PUBLISH_DIR: ./public
235235
```
236236

237+
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.
238+
239+
Be careful, `GITHUB_TOKEN` has no permission to access to external repositories.
240+
241+
242+
237243
## Tips and FAQ
238244

239245
### How to add `CNAME`

0 commit comments

Comments
 (0)