Configuration

The variables below set up the behaviour of the GitHub Action.

See the example for more context.

source-directory

Directory that the GitHub Action will push files from.

Note

It can be . to push all of the repository, but read the FAQ.

destination-github-username

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 .

destination-repository-name

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.

user-email [optional]

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.

user-name [optional]

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.

target-branch [optional]

The branch name for the destination repository. It defaults to main .

destination-repository-username [optional]

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 .

commit-message [optional]

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.

target-directory [optional]

The directory to wipe and replace in the target repository. Defaults to wiping the entire destination repository.

github-server [optional]

Defaults to github.com. Needs to be different if using GitHub for Enterprise.

create-target-branch-if-needed [optional]

Boolean (true/false). Defaults to false. If it’s true: if the destination branch does not exist it is created.