Skip to content

Commit

Permalink
README: two fixes from target-directory work
Browse files Browse the repository at this point in the history
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`.
  • Loading branch information
nedbat committed Dec 28, 2021
1 parent 9077ab5 commit 2e729bf
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -37,11 +37,11 @@ The branch name for the destination repository. It defaults to `main`.
### `commit-message` (argument) [optional]
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]
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)
E.g.:
`API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}`
Expand Down

0 comments on commit 2e729bf

Please sign in to comment.