status-im
/
actions-gh-pages
mirror of https://github.com/status-im/actions-gh-pages.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Improve description of destination_dir and keep_files (#569) 

https://github.com/peaceiris/actions-gh-pages/issues/324#issuecomment-779218091

Co-authored-by: Matthias Mohr <webmaster@mamo-net.de>
This commit is contained in:
Shohei Ueda 2021-02-16 20:13:09 +09:00 committed by GitHub
parent d3a97d53a8
commit e27e41d7ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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 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.