Skip to content

Commit

Permalink
Force docusaurus project to use npm (#581)
Browse files Browse the repository at this point in the history
* We were missing package-lock.json which i think cloudflare checks the
presence of to decide to use npm over yarn
* Added yarn.lock to .gitignore. I think trying to support yarn will
just bring us heartache. we use this strategy in our other docusaurus
deployments.
* Updated the CI to use npm over yarn
  • Loading branch information
bhelx authored Oct 16, 2024
1 parent c1a462a commit 2b3a897
Show file tree
Hide file tree
Showing 5 changed files with 17,253 additions and 9,957 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,13 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: '22'
cache: 'yarn'
cache-dependency-path: 'docs/yarn.lock'
- name: Build Chicory
run: mvn -B -Dquickly
- name: Test Docs
working-directory: docs
run: |
yarn install --frozen-lockfile
yarn test
npm install
npm run test
test-results:
name: Test Results
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ yarn-error.log*
.pnp.*
*.wasm
*.result

yarn.lock
21 changes: 3 additions & 18 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,22 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
### Installation

```
$ yarn
$ npm install
```

### Local Development

```
$ yarn start
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Loading

0 comments on commit 2b3a897

Please sign in to comment.