The variables below set up the behaviour of the GitHub Action.
See the :ref:`example <generic_example>` for more context.
Directory that the GitHub Action will push files from.
Note
It can be .
to push all of the repository, but read the FAQ.
Username/Organization of the GitHub repository that will be used for the destination
repository. To output to a repository such as https://github.com/cpina/push-to-another-repository-output this variable would be cpina
.
Name of the destination
repository. To output to a repository such as https://github.com/cpina/push-to-another-repository-output this variable would be push-to-another-repository-output
.
Warning
The GitHub Action deletes all the files and directories in the destination directory.
The email address that will be used for the commit to the destination-repository-name
, normally that of the "Author" of the generated commit.
If it is not specified, the commit will not have the author's email in the commit.
The name that will be used for the commit to the destination-repository-name. If not specified, the destination-github-username
will be used instead.
The branch name for the destination repository. It defaults to main
.
The Username/Organization for the destination repository, if different from destination-github-username
. For the repository https://github.com/cpina/push-to-another-repository-output this variable would be cpina
.
The commit message to be used in the output repository. Optional and defaults to Update from ORIGIN_COMMIT
.
The string ORIGIN_COMMIT
is replaced by $ORIGIN_REPOSITORY_URL@commit
.
The directory to wipe and replace in the target repository. Defaults to wiping the entire destination repository.
Defaults to github.com. Needs to be different if using GitHub for Enterprise.
Boolean (true
/false
). Defaults to false
. If it's true
: if the destination branch does not exist it is created.