From 2e729bfae741e1779add13ff8ee28c0dbb4c775d Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 28 Dec 2021 06:25:56 -0500 Subject: [PATCH] README: two fixes from target-directory work 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`. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf03e5f..b4eaaec 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 }}`