Skip to content

Commit

Permalink
[deploy_website] another attempt
Browse files Browse the repository at this point in the history
  • Loading branch information
ardatan committed Aug 10, 2020
1 parent 333cb3c commit f166fb4
Show file tree
Hide file tree
Showing 14 changed files with 98 additions and 97 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ jobs:
${{ runner.os }}-14-15-yarn-
- name: Install Dependencies using Yarn
run: yarn install && git checkout yarn.lock
- name: Build API Docs
run: yarn build:api-docs
- name: Deploy 🚀
run: yarn deploy:website
env:
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Useful tools to create and manipulate GraphQL schemas.",
"private": true,
"scripts": {
"predeploy:website": "yarn build:api-docs",
"deploy:website": "cd website && yarn deploy",
"ts:transpile": "tsc --project tsconfig.build.json",
"build": "yarn ts:transpile && bob build",
Expand Down Expand Up @@ -84,4 +85,4 @@
"resolutions": {
"graphql": "15.3.0"
}
}
}
1 change: 0 additions & 1 deletion scripts/build-api-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ const fs = require('fs');
const path = require('path');
const rimraf = require('rimraf');
const TypeDoc = require('typedoc');
const { transpileModule } = require('typescript');
const { execSync } = require('child_process');

// Where to generate the API docs
Expand Down
3 changes: 3 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Generated API Docs
/docs/api
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This loader loads a schema from Apollo Engine

## Implements

* [Loader](../interfaces/_utils_src_index_.loader.md)[ApolloEngineOptions](../interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions.md)
* [Loader](/docs/api/interfaces/_utils_src_index_.loader)[ApolloEngineOptions](/docs/api/interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions)

## Index

Expand Down Expand Up @@ -54,7 +54,7 @@ ___

### load

**load**(`_`: "apollo-engine", `options`: [ApolloEngineOptions](../interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**load**(`_`: "apollo-engine", `options`: [ApolloEngineOptions](/docs/api/interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

*Defined in [packages/loaders/apollo-engine/src/index.ts:36](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/apollo-engine/src/index.ts#L36)*

Expand All @@ -63,9 +63,9 @@ ___
Name | Type |
------ | ------ |
`_` | "apollo-engine" |
`options` | [ApolloEngineOptions](../interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions.md) |
`options` | [ApolloEngineOptions](/docs/api/interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions) |

**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

___

Expand All @@ -83,7 +83,7 @@ ___

**loaderId**(): *string*

*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)*
*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)*

*Defined in [packages/loaders/apollo-engine/src/index.ts:24](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/apollo-engine/src/index.ts#L24)*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Supported extensions include: `.ts`, `.tsx`, `.js`, `.jsx`, `.vue`

## Implements

* [Loader](../interfaces/_utils_src_index_.loader.md)[CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)
* [Loader](/docs/api/interfaces/_utils_src_index_.loader)[CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)

## Index

Expand Down Expand Up @@ -73,7 +73,7 @@ ___

### load

**load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

*Defined in [packages/loaders/code-file/src/index.ts:80](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/code-file/src/index.ts#L80)*

Expand All @@ -84,13 +84,13 @@ Name | Type |
`pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) |
`options` | [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions) |

**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

___

### loadSync

**loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *[Source](../interfaces/_utils_src_index_.source.md)*
**loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)*

*Defined in [packages/loaders/code-file/src/index.ts:123](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/code-file/src/index.ts#L123)*

Expand All @@ -101,15 +101,15 @@ Name | Type |
`pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) |
`options` | [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions) |

**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)*
**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)*

___

### loaderId

**loaderId**(): *string*

*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)*
*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)*

*Defined in [packages/loaders/code-file/src/index.ts:51](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/code-file/src/index.ts#L51)*

Expand Down
12 changes: 6 additions & 6 deletions website/docs/api/classes/_loaders_git_src_index_.gitloader.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const typeDefs = await loadTypedefs('git:someBranch:some/path/to/file.js', {

## Implements

* [Loader](../interfaces/_utils_src_index_.loader.md)
* [Loader](/docs/api/interfaces/_utils_src_index_.loader)

## Index

Expand Down Expand Up @@ -66,7 +66,7 @@ ___

### load

**load**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**load**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

*Defined in [packages/loaders/git/src/index.ts:62](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/git/src/index.ts#L62)*

Expand All @@ -77,13 +77,13 @@ Name | Type |
`pointer` | string |
`options` | [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions) |

**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

___

### loadSync

**loadSync**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *[Source](../interfaces/_utils_src_index_.source.md)*
**loadSync**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)*

*Defined in [packages/loaders/git/src/index.ts:79](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/git/src/index.ts#L79)*

Expand All @@ -94,15 +94,15 @@ Name | Type |
`pointer` | string |
`options` | [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions) |

**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)*
**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)*

___

### loaderId

**loaderId**(): *string*

*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)*
*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)*

*Defined in [packages/loaders/git/src/index.ts:50](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/git/src/index.ts#L50)*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const typeDefs = await loadTypedefs('github:githubUser/githubRepo#branchName:pat

## Implements

* [Loader](../interfaces/_utils_src_index_.loader.md)[GithubLoaderOptions](../interfaces/_loaders_github_src_index_.githubloaderoptions.md)
* [Loader](/docs/api/interfaces/_utils_src_index_.loader)[GithubLoaderOptions](/docs/api/interfaces/_loaders_github_src_index_.githubloaderoptions)

## Index

Expand Down Expand Up @@ -61,7 +61,7 @@ ___

### load

**load**(`pointer`: string, `options`: [GithubLoaderOptions](../interfaces/_loaders_github_src_index_.githubloaderoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md) | object›*
**load**(`pointer`: string, `options`: [GithubLoaderOptions](/docs/api/interfaces/_loaders_github_src_index_.githubloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source) | object›*

*Defined in [packages/loaders/github/src/index.ts:63](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/github/src/index.ts#L63)*

Expand All @@ -70,9 +70,9 @@ ___
Name | Type |
------ | ------ |
`pointer` | string |
`options` | [GithubLoaderOptions](../interfaces/_loaders_github_src_index_.githubloaderoptions.md) |
`options` | [GithubLoaderOptions](/docs/api/interfaces/_loaders_github_src_index_.githubloaderoptions) |

**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md) | object›*
**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source) | object›*

___

Expand All @@ -90,7 +90,7 @@ ___

**loaderId**(): *string*

*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)*
*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)*

*Defined in [packages/loaders/github/src/index.ts:51](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/github/src/index.ts#L51)*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const schema = await loadSchema('graphql/*.graphql', {

## Implements

* [Loader](../interfaces/_utils_src_index_.loader.md)[GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)
* [Loader](/docs/api/interfaces/_utils_src_index_.loader)[GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)

## Index

Expand All @@ -49,7 +49,7 @@ const schema = await loadSchema('graphql/*.graphql', {

### canLoad

**canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *Promise‹boolean›*
**canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *Promise‹boolean›*

*Defined in [packages/loaders/graphql-file/src/index.ts:62](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L62)*

Expand All @@ -58,15 +58,15 @@ const schema = await loadSchema('graphql/*.graphql', {
Name | Type |
------ | ------ |
`pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) |
`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) |
`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) |

**Returns:** *Promise‹boolean›*

___

### canLoadSync

**canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *boolean*
**canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *boolean*

*Defined in [packages/loaders/graphql-file/src/index.ts:76](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L76)*

Expand All @@ -75,15 +75,15 @@ ___
Name | Type |
------ | ------ |
`pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) |
`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) |
`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) |

**Returns:** *boolean*

___

### handleFileContent

**handleFileContent**(`rawSDL`: string, `pointer`: string, `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *object | object*
**handleFileContent**(`rawSDL`: string, `pointer`: string, `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *object | object*

*Defined in [packages/loaders/graphql-file/src/index.ts:100](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L100)*

Expand All @@ -93,15 +93,15 @@ Name | Type |
------ | ------ |
`rawSDL` | string |
`pointer` | string |
`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) |
`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) |

**Returns:** *object | object*

___

### load

**load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

*Defined in [packages/loaders/graphql-file/src/index.ts:87](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L87)*

Expand All @@ -110,15 +110,15 @@ ___
Name | Type |
------ | ------ |
`pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) |
`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) |
`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) |

**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)*
**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)*

___

### loadSync

**loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *[Source](../interfaces/_utils_src_index_.source.md)*
**loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)*

*Defined in [packages/loaders/graphql-file/src/index.ts:94](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L94)*

Expand All @@ -127,17 +127,17 @@ ___
Name | Type |
------ | ------ |
`pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) |
`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) |
`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) |

**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)*
**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)*

___

### loaderId

**loaderId**(): *string*

*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)*
*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)*

*Defined in [packages/loaders/graphql-file/src/index.ts:58](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L58)*

Expand Down
Loading

0 comments on commit f166fb4

Please sign in to comment.