From 61d0646c223874828ee5db47cce7f1475945d0ae Mon Sep 17 00:00:00 2001 From: Carles Pina i Estany Date: Wed, 4 Nov 2020 15:20:40 +0000 Subject: [PATCH] Improve documentation --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0505312..0f8a999 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # github-action-push-to-another-repository -Used to push generated files from a directory from Git Action step into another repository on Github. +Used to push generated files from a directory from Git Action step into another repository on Github. By design it deletes the files from the destination directory as it is meant to "publish" a set generated files. E.g. Repository pandoc-test contains Markdown and a Git Action to generate, using Pandoc, an output: HTML, PDF, odt, epub, etc. @@ -19,6 +19,8 @@ For the repository `https://github.com/cpina/push-to-another-repository-output` ### `destination-repository-name` (argument) For the repository `https://github.com/cpina/push-to-another-repository-output` is `push-to-another-repository-output` +*Warning:* this Github Action currently deletes all the files and directories in the destination repository. The idea is to copy from an `output` directory into the `destination-repository-name` having a copy without any previous files there. + ### `user-email` (argument) The email that will be used for the commit in the destination-repository-name.