Skip to content

Commit 825c0f1

Browse files
committed
Add GH Pages note to BUILD.md
1 parent de3fa4a commit 825c0f1

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

BUILD.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,4 +119,15 @@ yarn workspace hyperdrive-trading build
119119
```
120120

121121
This will create a static site in the
122-
[`apps/hyperdrive-trading/dist`](./apps/hyperdrive-trading/dist) directory.
122+
[`apps/hyperdrive-trading/dist`](./apps/hyperdrive-trading/dist) directory.
123+
124+
> [!NOTE]
125+
>
126+
> The repo includes a [GitHub Actions
127+
> workflow](https://docs.github.com/en/actions) for deploying to [GitHub
128+
> Pages](https://pages.github.com/) located at
129+
> [.github/workflows/gh-pages.yml](.github/workflows/gh-pages.yml). To enable
130+
> it, go to the repo's **Settings** > **Pages** and select **"GitHub Actions"**
131+
> as the **Source** under **Build and deployment**. The workflow includes some
132+
> [hardcoded environment variables](.github/workflows/gh-pages.yml#L41), so you
133+
> may want to update them in the workflow file before enabling it.

0 commit comments

Comments
 (0)