Skip to content

Commit

Permalink
chore: recursive builds (#2101)
Browse files Browse the repository at this point in the history
* Update token-introspection linking

* Update docs build script name

* Format

* Update README and netlify.toml

* Reword sentence in REAMDE

---------

Co-authored-by: Chen Hui Jing <[email protected]>
  • Loading branch information
raducristianpopa and huijing authored Oct 26, 2023
1 parent 16adf55 commit 1845c53
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 8 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,14 @@ pnpm i

### Local Development

The Rafiki local environment is the best way to explore Rafiki locally. The [localenv](localenv) directory contains instructions for setting up a local playground.
The Rafiki local environment is the best way to explore Rafiki locally. The [localenv](localenv) directory contains instructions for setting up a local playground. Please refer to the README for each individual package for more details.

### Useful commands

```sh
# build all the packages in the repo:
pnpm -r build

# build specific package (e.g. backend):
pnpm --filter backend build

Expand Down
2 changes: 1 addition & 1 deletion packages/auth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"objection-db-errors": "^1.1.2",
"pg": "^8.11.3",
"pino": "^8.16.1",
"token-introspection": "workspace:../token-introspection",
"token-introspection": "workspace:*",
"uuid": "^9.0.1"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"pino": "^8.16.1",
"raw-body": "^2.5.2",
"tigerbeetle-node": "^0.13.57",
"token-introspection": "workspace:../token-introspection",
"token-introspection": "workspace:*",
"uuid": "^9.0.1"
}
}
8 changes: 7 additions & 1 deletion packages/documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ This website is built with [Starlight](https://starlight.astro.build/), a docume
$ pnpm i
```

- In order to support Mermaid syntax in markdown, we are relying on the [rehype-mermaid](https://github.com/remcohaszing/rehype-mermaid) plugin. This plugin has an unfortunate dependency on [Playwright](https://playwright.dev/).

```sh
$ pnpm dlx playwright install chromium
```

- Run the dev server from the /packages/documentation folder:

```sh
Expand All @@ -25,7 +31,7 @@ This command starts a local development server and opens up a browser window. Mo
- Build the site, again, this must be run from the /packages/documentation folder:

```sh
$ pnpm build
$ pnpm build:docs
```

This command generates static content into the build directory and can be served using any static contents hosting service.
Expand Down
2 changes: 1 addition & 1 deletion packages/documentation/netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
publish = "build/"

# Default build command.
command = "pnpm install --no-frozen-lockfile && pnpm dlx playwright install chromium && pnpm build"
command = "pnpm install --no-frozen-lockfile && pnpm dlx playwright install chromium && pnpm build:docs"
2 changes: 1 addition & 1 deletion packages/documentation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"version": "0.0.1",
"scripts": {
"start": "astro dev",
"build": "astro build",
"build:docs": "astro build",
"preview": "astro preview",
"astro": "astro"
},
Expand Down
4 changes: 2 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1845c53

Please sign in to comment.