actions/github-action-push-to-another-repository
1
0
Fork 0
mirror of https://github.com/cpina/github-action-push-to-another-repository.git synced 2024-12-22 08:06:10 -07:00
Code Issues Packages Projects Releases Wiki Activity

README: two fixes from target-directory work

Browse Source 
1. The sentence about `ORIGIN_COMMIT` should be part of the description
   of `commit-message`.

2. The title of the repo is still `github-action-push-to-another-repository`.
This commit is contained in:
Ned Batchelder 2021-12-28 06:25:56 -05:00
parent 9077ab5399
commit 2e729bfae7
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,4 +1,4 @@
# github-action-push-to-another-repository-directory # github-action-push-to-another-repository
When to use this GitHub Action? It is useful in case that you have a GitHub repository with a a directory that you want to push to another GitHub repository using GitHub Actions (automated on push, for example). It is also useful if using GitHub Actions you generate certain files that you want to push to another GitHub repository. When to use this GitHub Action? It is useful in case that you have a GitHub repository with a a directory that you want to push to another GitHub repository using GitHub Actions (automated on push, for example). It is also useful if using GitHub Actions you generate certain files that you want to push to another GitHub repository.
@ -37,11 +37,11 @@ The branch name for the destination repository. It defaults to `main`.
### `commit-message` (argument) [optional] ### `commit-message` (argument) [optional]
The commit message to be used in the output repository. Optional and defaults to "Update from $REPOSITORY_URL@commit". The commit message to be used in the output repository. Optional and defaults to "Update from $REPOSITORY_URL@commit".
The string `ORIGIN_COMMIT` is replaced by `$REPOSITORY_URL@commit`.
### `target-directory` (argument) [optional] ### `target-directory` (argument) [optional]
The directory to wipe and replace in the target repository. Defaults to wiping the entire repository The directory to wipe and replace in the target repository. Defaults to wiping the entire repository
The string `ORIGIN_COMMIT` is replaced by `$REPOSITORY_URL@commit`.
### `API_TOKEN_GITHUB` (environment) ### `API_TOKEN_GITHUB` (environment)
E.g.: E.g.:
`API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}` `API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}`