jekyll-github-deploy icon indicating copy to clipboard operation
jekyll-github-deploy copied to clipboard
verified publisher icon yegor256

(feature) copy files to root of repository before pushing / keep README in pushed branch

Open fwolfst opened this issue 5 years ago • 5 comments

I figured that for github "user" pages on github.io only the master branch can be used to serve the (via jgd: static) content.

I was very happy to see that with jgd -b master -r source I can still use jgd such that user.github.io will show me the rendered version.

However, now when browsing the repo on github, people do not see the README.md anymore (in which I would also state that I use jgd, and how). Thus it would be cool if jgd would have a --copy-readme (or --copy-file README.md) flag to copy the README.md over before pushing to the master branch.

fwolfst avatar Jun 03 '20 17:06 fwolfst

@yegor256/z please, pay attention to this issue

0crat avatar Jun 03 '20 17:06 0crat

I can draft a small nasty PR if you wish, basically guarding the rm README thing in the bash script.

fwolfst avatar Jun 07 '20 20:06 fwolfst

@fwolfst isn't is copying the file by default? I don't understand the problem...

yegor256 avatar Aug 05 '20 12:08 yegor256

@yegor256 yes its copied but then deleted: https://github.com/yegor256/jekyll-github-deploy/blob/587c67d481071a739c6681dff2ab419d0fd80db9/bash/deploy.sh#L55 . My PR adds an option to not delete the README.md .

fwolfst avatar Oct 29 '20 11:10 fwolfst

In that sense, from a developer-perspective the flag shouldnt be called copy-readme but rather do-not-delete-readme, but from a users perspective that doesnt make much sense. Maybe --keep-readme ?

fwolfst avatar Oct 29 '20 11:10 fwolfst