From 6a7c0e7bec2780d68d0b4532267f91cbf9091b79 Mon Sep 17 00:00:00 2001 From: kyle roux Date: Thu, 26 Sep 2019 14:34:18 -0700 Subject: [PATCH 1/2] added beta publish instructions to the README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 7521a5e..0cec82e 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,34 @@ This action isn't that, though I've borrowed much of the git action from these w **This action will not build anything, it just deploys.** +**This action cannot publish a pages site that does not exist** + +Currently the Github Actions feature is still in __Beta__, +and while it is actions are unable to trigger the initial build +on github which publishs the repos project pages site. + +If your repo does not have a project pages site yet, +for this to work you will need to push to pages from +an account that has admin privilages on the repo, the eaisest +way to do this is to clone the repo using the account: + +```bash +$ git clone https://YOUR_USERNAME:YOUR_PASSWORD@github.com/YOUR_USERNAME/YOUR_REPO +``` + +Then add and commit the files to be published, ie if i wanted to serve my new docs folder: + +```bash +$ git add -A docs +$ git commit -m 'YOUR COMMIT MESSAGE' +``` + +And finally, you can publish it to github pages using the `gh-pages` command line tool: + +```bash +$ npx gh-pages -d docs +``` + ## Secrets From 6bc3cded60b7fc3a18304731184afabe922d4b69 Mon Sep 17 00:00:00 2001 From: "Kyle J. Roux" Date: Fri, 25 Oct 2019 20:07:17 -0700 Subject: [PATCH 2/2] Update README.md Co-Authored-By: Vincent LE GOFF --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cec82e..1f91970 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ on github which publishs the repos project pages site. If your repo does not have a project pages site yet, for this to work you will need to push to pages from -an account that has admin privilages on the repo, the eaisest +an account that has admin privileges on the repo, the easiest way to do this is to clone the repo using the account: ```bash