Skip to content

Commit 57b4458

Browse files
authored
fix releases, node version, cleanup readme (#26)
1 parent 63f3d9f commit 57b4458

File tree

5 files changed

+30
-12
lines changed

5 files changed

+30
-12
lines changed

.github/workflows/ci.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ on: [push, pull_request]
44

55
jobs:
66
release:
7-
name: CI Build
7+
name: CI Build & Test
88
runs-on: ubuntu-latest
9+
strategy:
10+
matrix:
11+
node: ['14', '16', '17', '18', '20']
912
steps:
1013
- name: Checkout Repo
1114
uses: actions/checkout@master
1215

13-
14-
- name: Setup Node.js 12.x
16+
- name: Setup Node.js 18.x
1517
uses: actions/setup-node@master
16-
with:
17-
node-version: 12.x
1818

1919
- name: Install Dependencies
2020
run: yarn
@@ -26,4 +26,4 @@ jobs:
2626
run: yarn build
2727

2828
- name: Test
29-
run: yarn test
29+
run: yarn test

.github/workflows/release.yml.disabled renamed to .github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ jobs:
1313
- name: Checkout Repo
1414
uses: actions/checkout@master
1515
with:
16-
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
16+
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
1717
fetch-depth: 0
1818

1919

20-
- name: Setup Node.js 12.x
20+
- name: Setup Node.js 18.x
2121
uses: actions/setup-node@master
2222
with:
23-
node-version: 12.x
23+
node-version: 18.x
2424

2525
- name: Install Dependencies
2626
run: yarn
@@ -32,4 +32,4 @@ jobs:
3232
publish: yarn release
3333
env:
3434
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35-
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
35+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
# relay-graphql-js
2+
23
Relay tooling based on graphql-js
4+

packages/graphql-config/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
[![npm](https://img.shields.io/npm/v/vscode-apollo-relay.svg)](https://www.npmjs.com/package/vscode-apollo-relay)
44
[![build](https://img.shields.io/travis/relay-tools/vscode-apollo-relay/master.svg)](https://travis-ci.org/relay-tools/vscode-apollo-relay/builds)
55

6-
Simple configuration for [`graphql-config`](https://graphql-config.com) compatibility for Relay projects.
6+
Simple configuration for [`graphql-config`](https://graphql-config.com) compatibility for Relay projects.
77

88
Features:
99

1010
- Read all user configuration from [relay-config], if the project is setup with it.
1111
- Provides definitions for all Relay directives for validation and auto-completion purposes.
1212
- Provides validation of `@argumentDefinitions` and `@arguments` directives.
13+
- uses your locally installed `graphql` version!
1314

1415
[Changelog](https://github.com/relay-tools/relay-graphql-js/blob/master/packages/graphql-config/CHANGELOG.md)
1516

@@ -22,12 +23,26 @@ npm install --save-dev @relay-graphql-js/graphql-config
2223
# using yarn
2324
yarn add --dev @relay-graphql-js/graphql-config
2425
```
26+
(assuming `graphql-config` is installed already, which is used only for types)
2527

2628
## Usage
2729

28-
In your `graphql.config.js` file:
30+
In your `graphql.config.ts` file:
31+
32+
```js
33+
import { generateConfig } from "@relay-graphql-js/graphql-config"
34+
const config = generateConfig();
35+
36+
export default config
37+
```
38+
39+
Or, in your `graphql.config.js` file:
2940

3041
```js
3142
const { config } = require("@relay-graphql-js/graphql-config").generateConfig()
3243
module.exports = config
3344
```
45+
46+
## Limitations
47+
48+
This _does not_ support relay environments => `graphql-config` projects, _yet_. Open a PR if you want it to!

packages/vscode-apollo-relay/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Features:
1010
- Read all user configuration from [relay-config], if the project is setup with it.
1111
- Provides definitions for all Relay directives for validation and auto-completion purposes.
1212
- Provides validation of `@argumentDefinitions` and `@arguments` directives.
13+
- uses your locally installed `graphql` version!
1314

1415
[Changelog](https://github.com/relay-tools/vscode-apollo-relay/blob/master/CHANGELOG.md)
1516

0 commit comments

Comments
 (0)