Merge pull request #51 from nedbat/nedbat/fix-readme

README: two fixes from target-directory work
This commit is contained in:
Carles Pina Estany 2021-12-28 20:39:26 +00:00 committed by GitHub
commit 164a872083
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

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 }}`