Welcome to github-action-push-to-another-repository’s documentation!

Warning

TL;DR: the GitHub Action is not maintained for any new development. I plan to fix issues if they arise due to changes on GitHub, to minimise disruption of existing usage.

My circumstances changed since I started the GitHub Action in 2020. I am not able to add functionality to it or fix issues.

The action is 175 lines of shell script. Feel free to fork it and modify it for your own use case.

If you create a fork that might replace this one, I will add a note in the documentation and the README.md. Please, open an issue and I will do it.

This GitHub Action (github-action-push-to-another-repository) pushes files from one GitHub repository to another. For example, on a git push in a source repository, files can be pushed into a destination repository.

Two of examples of this could be:

• Specifying a directory in a source repository to be pushed to a destination repository

• Generating some files using another GitHub Action and pushing them into another destination repository (e.g. generating PDFs from MarkDown and pushing the PDFs across to the destination repository)

The GitHub Action code is shorter than the documentation. It needs some setup and initial configuration which is covered in detail, but hopefully it will not take more than a few minutes.

Note

For a quickstart see the setup example.

Table of contents

• Overview
  • Features
• Configuration
  • source-directory
  • destination-github-username
  • destination-repository-name
  • user-email [optional]
  • user-name [optional]
  • target-branch [optional]
  • destination-repository-username [optional]
  • commit-message [optional]
  • target-directory [optional]
  • github-server [optional]
  • create-target-branch-if-needed [optional]
• Setup
  • SSH_DEPLOY_KEY Vs. API_TOKEN_GITHUB
  • Setup using SSH deploy keys
  • Setup using Personal Access Token
  • Write your .github/workflow/ci.yml
• Example setup
• Sphinx example
  • Introduction
  • Steps
  • Configuration
• Troubleshooting
  • Cannot push to the destination repository
    • Test connection to GitHub using the key pair
    • Verify that the key is in the correct repository
    • Verify the Permission of the key
    • Test the Personal Access Token
  • Error: URL using bad/illegal format or missing URL
  • Error: RPC failed; curl 92 HTTP/2 stream 0 was not closed cleanly: CANCEL (err 8)
  • Error: remote: Repository not found
• FAQ
  • Can github-action-push-to-another-repository be used to publish Sphinx documentation into GitHub pages?
  • How can I copy only some files / only some directories / exclude some files / etc.?
  • How can I copy the whole repository?
  • Could it work on Mac OS, Windows or No Docker environments?