Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.79 KB

index.rst

File metadata and controls

41 lines (29 loc) · 1.79 KB

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 :ref:`setup example<generic_example>`.

.. toctree::
  :caption: Table of contents

  overview.rst
  configuration.rst
  setup.rst
  generic-example.rst
  sphinx-example.rst
  troubleshooting.rst
  faq.rst