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

swap to pnpm and fix readme #139

Merged
merged 1 commit into from
Dec 17, 2024
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
11 changes: 6 additions & 5 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,17 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x, 20.x]
node-version: [18.x, 20.x, 22.x]
fail-fast: false

steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- run: npm ci
- run: npm run lint
- run: npm test
cache: 'pnpm'
- run: pnpm i --frozen-lockfile
- run: pnpm run lint
- run: pnpm test
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Ember JSON API Docs [![Build Status](https://travis-ci.org/ember-learn/ember-jsonapi-docs.svg?branch=master)](https://travis-ci.org/ember-learn/ember-jsonapi-docs)
# Ember JSON API Docs [![Build Status](https://github.com/ember-learn/ember-json-api-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/ember-learn/ember-jsonapi-docs/actions/workflows/ci.yaml)

This tool gets the code comments from `ember.js` and `ember-data` libraries,

This tool gets the code comments from `ember.js` and `ember-data` libraries,
turns them into JSON files, and then turns those JSON files into a
[JSON:API](http://jsonapi.org/) format.

Expand All @@ -13,7 +14,7 @@ The files this tool creates are used to power
## Prerequisites

- the latest [Node.js](https://nodejs.org/) LTS
- [yarn v1](https://yarnpkg.com/)
- [pnpm v9](https://pnpm.io/) (preferably managed via [corepack](https://github.com/nodejs/corepack))

Clone all of the following repositories into the same directory so they are "siblings" on the file system

Expand Down Expand Up @@ -45,8 +46,8 @@ files into the `s3-docs` directory of `ember-api-docs-data`:

```sh
cd ../ember-jsonapi-docs
yarn
yarn gen --project ember --version "5.2.0"
pnpm i
pnpm gen --project ember --version "5.2.0"
```

I would recommend committing in ember-api-docs-data at this stage so that you can see that the following steps work.
Expand Down
Loading
Loading