Skip to content

Commit

Permalink
(chore) fixes to build ci (#14)
Browse files Browse the repository at this point in the history
* (chore) fixes to build ci

* upgrades next version and ci

* adds pnpm action

* updates pnpm action name

* updates pnpm packages

* downgrades next version

* locks flexsearch version
  • Loading branch information
pirupius authored Jan 9, 2024
1 parent b5b0d85 commit 216ea15
Show file tree
Hide file tree
Showing 4 changed files with 1,687 additions and 957 deletions.
22 changes: 15 additions & 7 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,33 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Use Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: "18"

- name: Cache dependencies
id: cache
uses: actions/cache@v3
with:
path: "**/node_modules"
key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
path: |
~/.pnpm
${{ github.workspace }}/.next/cache
# Generate a new cache whenever packages or source files change.
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
# If source files changed but packages didn't, rebuild from a prior cache.
restore-keys: |
${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}-
- name: Install dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: yarn install --immutable
run: pnpm install

- name: Run build
run: yarn build
run: pnpm build

docs_deployment:
runs-on: ubuntu-latest
Expand Down
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
# O3 Docs
# React Form Engine and OHRI Docs

This documentation is intended to enable users to utilize the features of the React Form Engine (RFE).
This documentation is intended to enable users to utilize the features of the React Form Engine (RFE) as well as OHRI associated packages.

Local Development

To install the dependancies run:
```bash
yarn
pnpm install
```

To build the project run:
To start the dev server on port 3000 run:
```bash
yarn build
```

To start the dev server run:
```bash
yarn dev
pnpm run dev
```

The documentation website for the React Form Engne https://ohri-docs.globalhealthapp.net.
28 changes: 25 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
{
"name": "@ohri/docs",
"version": "0.1.0",
"description": "Documentation for React Form Engine for O3 and OHRI packages.",
"author": "OHRI",
"license": "MPL-2.0",
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start"
},
"repository": {
"type": "git",
"url": "git+https://github.com/UCSF-IGHS/ohri-docs.git"
},
"bugs": {
"url": "https://github.com/UCSF-IGHS/ohri-docs/issues"
},
"homepage": "https://ohri-docs.globalhealthapp.net/",
"dependencies": {
"@tailwindcss/typography": "^0.5.9",
"autoprefixer": "^10.4.14",
"next": "^13.2.4",
"nextra": "^2.2.20",
"nextra-theme-docs": "^2.2.20",
"next": "^13.0.6",
"nextra": "^2.13.2",
"nextra-theme-docs": "^2.13.2",
"postcss": "^8.4.21",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"sharp": "^0.32.0",
"tailwindcss": "^3.2.7"
},
"devDependencies": {
"@types/node": "18.11.10",
"typescript": "^4.9.3"
},
"pnpm": {
"overrides": {
"flexsearch": "0.7.31"
}
}
}
Loading

0 comments on commit 216ea15

Please sign in to comment.