Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switching from Yarn to npm #236

Merged
merged 1 commit into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,12 @@ Please make sure you have [set up your username and email address](https://git-s
## Specific set up for documentation application

Our documentation is build with [VitePress](https://vitepress.dev/), for set up a local environment to contribute follow these steps:
1. You'll need `node` (_we recommend using [nvm](https://github.com/nvm-sh/nvm)_) and `yarn` for set up the environment.
1. You'll need `node` (_we recommend using [nvm](https://github.com/nvm-sh/nvm)_) and `npm` for set up the environment.
* Using `nvm` you can execute `nvm use`(reads _.nvmrc_ file) in the project root directory and follow the instructions to use the correct `node` version.
* To use `yarn` you need to execute `corepack enable` to activate [Corepack](https://nodejs.org/api/corepack.html).
2. Install dependencies with `yarn install`.
3. Run local development server with `yarn docs:dev`.
2. Install dependencies with `npm ci`.
3. Run local development server with `npm run docs:dev`.
4. Implement your changes.
5. Before submitting your Pull Request run `docs:build` to ensure everything works.
5. Before submitting your Pull Request run `npm run docs:build` to ensure everything works.

## Change the configuration
To change the configuration for the project we use the `.env` file if you would like to know what variables should be there use the following command:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/check-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: 20
cache: yarn
cache: npm
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: yarn install --immutable
run: npm ci
- name: Build with VitePress
run: |
yarn docs:build
npm run docs:build
touch docs/.vitepress/dist/.nojekyll
6 changes: 3 additions & 3 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: 20
cache: yarn
cache: npm
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: yarn install --immutable
run: npm ci
- name: Build with VitePress
run: |
yarn docs:build
npm run docs:build
touch docs/.vitepress/dist/.nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
Expand Down
8 changes: 0 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,8 @@

# docs
node_modules
yarn-error.log
docs/.vitepress/cache
docs/.vitepress/dist
.yarn/*
!.yarn/cache
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions

# installation
bin/bashunit
893 changes: 0 additions & 893 deletions .yarn/releases/yarn-4.0.1.cjs

This file was deleted.

3 changes: 0 additions & 3 deletions .yarnrc.yml

This file was deleted.

Loading