-
-
Notifications
You must be signed in to change notification settings - Fork 388
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: enhance explanation for EXTERNAL_REPOSITORY
- Loading branch information
Showing
1 changed file
with
8 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: | ||
|
||
|
@@ -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` | ||
|