Skip to content
This repository has been archived by the owner on Dec 5, 2022. It is now read-only.

added beta publish instructions to the README #24

Open
wants to merge 2 commits into
base: grm2-master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 privileges on the repo, the easiest
way to do this is to clone the repo using the account:

```bash
$ git clone https://YOUR_USERNAME:[email protected]/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

Expand Down