Skip to content

Commit

Permalink
Update dev deps, switch to npm (#85)
Browse files Browse the repository at this point in the history
* yarn -> npm, bump dev deps

* Use npm@7 for CI

* Fine then, get npm@7 via node 15

* Set npm version for docs rebuilds as well
  • Loading branch information
eritbh authored Aug 22, 2021
1 parent 403c86f commit 0fb5a7f
Show file tree
Hide file tree
Showing 7 changed files with 3,421 additions and 1,309 deletions.
11 changes: 6 additions & 5 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ jobs:
steps:
- uses: actions/checkout@v1

- uses: actions/setup-node@v2
with:
node-version: 15 # earliest node that ships with npm@7

- name: Install dependencies
run: |
# Direct dependencies
yarn install
# Peer dependencies
npm i --no-save eris@0.15
npm ci
- name: Generate and push documentation
env:
Expand All @@ -36,7 +37,7 @@ jobs:
cd ..
# Generate documentation file and add file to list of versions
yarn run typedoc src/Yuuko.ts --out ".temp/docs/$TAG_NAME" --readme none
npx typedoc src/Yuuko.ts --out ".temp/docs/$TAG_NAME" --readme none
echo "- '$TAG_NAME'" >> .temp/_data/docs.yml
# Add generated files that start with underscores to Jekyll `include`
Expand Down
15 changes: 8 additions & 7 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,21 @@ jobs:
steps:
- uses: actions/checkout@v1

- uses: actions/setup-node@v2
with:
node-version: 15 # earliest node that ships with npm@7

- name: Install dependencies
run: |
# Direct dependencies
yarn install
# Peer dependencies
npm i --no-save eris@0.15
npm ci
- name: Run ESLint
run: |
yarn run lint
npm run lint
- name: Build Typescript
run: |
yarn run build
npm run build
- name: Push build artifacts
env:
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
node_modules
_site
.jekyll-cache
yarn-error.log
.DS_STORE
.vscode

Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,13 @@ The goal of this module is to provide a starting point for bots of all sizes. Yu

## Installation

Yuuko expects Eris to be installed as a peer dependency, which allows you to use any forward-compatible Eris version without having to wait for an update to Yuuko. You can install both at once with the following commands:
Yuuko expects Eris to be installed as a peer dependency, which allows you to use any forward-compatible Eris version without having to wait for an update to Yuuko. Using npm, you can install both at once with this command:

```bash
$ yarn add --production yuuko eris # yarn
$ npm install --save --production yuuko eris # npm
$ npm install yuuko eris
```

The minimum required Eris version is 0.13.0, though you should use the latest version whenever possible.
Generally, the latest version of Eris is the only one actively tested against. You can try older versions, but there's no guarantee they'll work - Yuuko is often updated to take advantage of the latest changes to Eris.

### Development builds

Expand Down
Loading

0 comments on commit 0fb5a7f

Please sign in to comment.