Skip to content

Commit 80a14d4

Browse files
[Infra] - Configure for GitHub Pages auto-deployment
1 parent 336bca5 commit 80a14d4

3 files changed

Lines changed: 76 additions & 8 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
# Only one deployment runs at a time; queued runs wait, in-progress ones are not cancelled.
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
24+
- uses: dart-lang/setup-dart@v1
25+
with:
26+
sdk: stable
27+
28+
- name: Install jaspr_cli
29+
run: dart pub global activate jaspr_cli
30+
31+
- name: Install dependencies
32+
run: dart pub get
33+
34+
- name: Build site
35+
run: jaspr build
36+
37+
- name: Upload Pages artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: build/jaspr/
41+
42+
deploy:
43+
needs: build
44+
runs-on: ubuntu-latest
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
1-
# renderobjects
1+
# RenderObjects.com
2+
Articles and guides to help developers create their own `RenderObject`s.
23

3-
A documentation site built with Jaspr
4+
## Local Development
45

5-
## Running the project
6+
Install the Jaspr CLI:
7+
```sh
8+
dart pub global activate jaspr_cli
9+
```
610

7-
Run your project using `jaspr serve`.
811

9-
The development server will be available on `http://localhost:8080`.
12+
## Build
13+
```sh
14+
jaspr build
15+
```
1016

11-
## Building the project
17+
Output is written to `build/jaspr/`.
1218

13-
Build your project using `jaspr build`.
19+
## Serve Locally
20+
```sh
21+
jaspr serve
22+
```
23+
24+
Available locally at `http://localhost:8080`.
25+
26+
## Deploy to Production
27+
28+
Merging to `main` automatically builds and deploys the site to [renderobjects.com](https://renderobjects.com) via GitHub Actions and GitHub Pages.
29+
30+
To deploy, open a PR against `main` and merge it. The deployment workflow runs on every push to `main`; progress is visible under the repo's **Actions** tab.
1431

15-
The output will be located inside the `build/jaspr/` directory.

web/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
renderobjects.com

0 commit comments

Comments
 (0)