Skip to content

Commit

Permalink
chore: adds gh-pages deploy support on coordinator releases
Browse files Browse the repository at this point in the history
  • Loading branch information
bucko13 committed Feb 13, 2024
1 parent f8e092a commit f46fe29
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 5 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Deploy

on:
push:
tags:
- '@caravan/coordinator@*'

permissions:
contents: write

jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3

- name: Install dependencies
run: npm install

- name: Deploy
run: npx turbo run deploy
20 changes: 15 additions & 5 deletions apps/coordinator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,22 @@ a copy of Caravan hosted on GitHub by
If you would prefer to host your own copy of Caravan on GitHub, you
can do so by first forking the
[Caravan repository](https://github.com/unchained-capital/caravan)
into your own GitHub organization. You should see a copy of the
Caravan web application at
`https://YOUR_GITHUB_USERNAME.github.io/caravan`.
into your own GitHub organization. Go to the (newly forked) repository's "Settings" page and
scroll down to the "GitHub Pages" section. Make sure to setup the settings
to us a gh-pages branch (create the branch if necessary).

If not, go to the (newly forked) repository's "Settings" page and
scroll down to the "GitHub Pages" section. Ensure you see a message
You may need to run a deploy manually from your computer for the first time.

```shell
$ git clone https://YOUR_GITHUB_USERNAME.github.io/caravan
$ cd caravan
$ npm install
$ turbo run deploy
```

You should see a copy of the Caravan web application at
`https://YOUR_GITHUB_USERNAME.github.io/caravan`. If not, go back to the
GitHub Pages section and ensure you see a message
saying "Your site is published at ...".

### Host Locally
Expand Down
4 changes: 4 additions & 0 deletions turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,9 @@
"cache": false,
"persistent": true
}
,
"deploy": {
"dependsOn": ["build", "test", "lint"]
}
}
}

0 comments on commit f46fe29

Please sign in to comment.