Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
fwolfst opened this issue Jun 3, 2020 · 5 comments

Comments

@fwolfst
Copy link

fwolfst commented Jun 3, 2020

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.

@0crat
Copy link
Collaborator

0crat commented Jun 3, 2020

@yegor256/z please, pay attention to this issue

@fwolfst
Copy link
Author

fwolfst commented Jun 7, 2020

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

fwolfst added a commit to econya/jekyll-github-deploy that referenced this issue Jun 7, 2020
prevents removing the README.md file (yegor256#32)
@yegor256
Copy link
Owner

yegor256 commented Aug 5, 2020

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

@fwolfst
Copy link
Author

fwolfst commented Oct 29, 2020

@yegor256 yes its copied but then deleted:

rm -f README.md
. My PR adds an option to not delete the README.md .

@fwolfst
Copy link
Author

fwolfst commented Oct 29, 2020

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 fwolfst changed the title (feature) copy files to root of repository before pusing (feature) copy files to root of repository before pushing / keep README in pushed branch Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants