From 4a95b89914507603116fef0a9d1d58dcf7cb26ca Mon Sep 17 00:00:00 2001 From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com> Date: Tue, 16 Feb 2021 19:50:33 +0900 Subject: [PATCH 1/2] docs: Improve description of destination_dir and keep_files https://github.com/peaceiris/actions-gh-pages/issues/324#issuecomment-779218091 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e9029b742..e27f04071 100644 --- a/README.md +++ b/README.md @@ -333,7 +333,7 @@ For example: ### ⭐️ Keeping existing files `keep_files` -By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`. +By default, existing files in the publishing directory (or `destination_dir` if you use) will be removed. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`. Note that users who are using a Static Site Generator do not need this option in most cases. Please reconsider your project structure and building scripts, or use a built-in feature of a Static Site Generator before you enable this flag. From 51624e30fd76b2f906099dc43136fa1f5ed84663 Mon Sep 17 00:00:00 2001 From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com> Date: Tue, 16 Feb 2021 20:08:11 +0900 Subject: [PATCH 2/2] Update README.md Co-authored-by: Matthias Mohr --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e27f04071..b30696cc1 100644 --- a/README.md +++ b/README.md @@ -333,7 +333,7 @@ For example: ### ⭐️ Keeping existing files `keep_files` -By default, existing files in the publishing directory (or `destination_dir` if you use) will be removed. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`. +By default, existing files in the publish branch (or only in `destination_dir` if given) will be removed. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`. Note that users who are using a Static Site Generator do not need this option in most cases. Please reconsider your project structure and building scripts, or use a built-in feature of a Static Site Generator before you enable this flag.