Skip to content

Commit c404887

Browse files
moufmoufmoufmouf
committed
Fixing doc deployment action
1 parent d6ac98d commit c404887

File tree

3 files changed

+26
-16
lines changed

3 files changed

+26
-16
lines changed

‎.github/workflows/doc_generation.yml‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,26 @@ jobs:
2121
uses: actions/setup-node@v1
2222
with:
2323
node-version: '12.x'
24-
25-
- name: "Update git config"
26-
run: git config --global user.name "${GH_NAME}" && git config --global user.email "${GH_EMAIL}" && echo "machine github.com login ${GH_NAME} password ${GITHUB_TOKEN}" > ~/.netrc
27-
24+
25+
# - name: "Update git config"
26+
# run: git config --global user.name "${GH_NAME}" && git config --global user.email "${GH_EMAIL}" && echo "machine github.com login ${GH_NAME} password ${GITHUB_TOKEN}" > ~/.netrc
27+
2828
- name: "Yarn install"
2929
run: yarn install
3030
working-directory: "website"
31-
32-
- name: "Push the new doc"
33-
run: GIT_USER="${GH_NAME}" yarn run publish-gh-pages
31+
32+
# - name: "Push the new doc"
33+
# run: GIT_USER="${{ github.actor }}" yarn run publish-gh-pages
34+
# working-directory: "website"
35+
36+
- name: "Yarn build"
37+
run: yarn run build
3438
working-directory: "website"
3539

36-
40+
- name: "Deploy website"
41+
uses: JamesIves/github-pages-deploy-action@3.7.1
42+
with:
43+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
44+
BRANCH: gh-pages # The branch the action should deploy to.
45+
FOLDER: website/build # The folder the action should deploy.
46+
CLEAN: true # Automatically remove deleted files from the deploy branch

‎website/versioned_docs/version-3.0/annotations_reference.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `@Query` annotation is used to declare a GraphQL query.
1414
Attribute | Compulsory | Type | Definition
1515
---------------|------------|------|--------
1616
name | *no* | string | The name of the query. If skipped, the name of the method is used instead.
17-
[outputType](custom_output_types.md) | *no* | string | Forces the GraphQL output type of a query.
17+
[outputType](type_mapping.md) | *no* | string | Forces the GraphQL output type of a query.
1818

1919
## @Mutation annotation
2020

@@ -25,7 +25,7 @@ The `@Mutation` annotation is used to declare a GraphQL mutation.
2525
Attribute | Compulsory | Type | Definition
2626
---------------|------------|------|--------
2727
name | *no* | string | The name of the mutation. If skipped, the name of the method is used instead.
28-
[outputType](custom_output_types.md) | *no* | string | Forces the GraphQL output type of a query.
28+
[outputType](type_mapping.md) | *no* | string | Forces the GraphQL output type of a query.
2929

3030
## @Type annotation
3131

@@ -57,7 +57,7 @@ The `@Field` annotation is used to declare a GraphQL field.
5757
Attribute | Compulsory | Type | Definition
5858
---------------|------------|------|--------
5959
name | *no* | string | The name of the field. If skipped, the name of the method is used instead.
60-
[outputType](custom_output_types.md) | *no* | string | Forces the GraphQL output type of a query.
60+
[outputType](type_mapping.md) | *no* | string | Forces the GraphQL output type of a query.
6161

6262
## @SourceField annotation
6363

@@ -68,7 +68,7 @@ The `@SourceField` annotation is used to declare a GraphQL field.
6868
Attribute | Compulsory | Type | Definition
6969
---------------|------------|------|--------
7070
name | *yes* | string | The name of the field.
71-
[outputType](custom_output_types.md) | *no* | string | Forces the GraphQL output type of the field. Otherwise, return type is used.
71+
[outputType](type_mapping.md) | *no* | string | Forces the GraphQL output type of the field. Otherwise, return type is used.
7272
logged | *no* | bool | Whether the user must be logged or not to see the field.
7373
right | *no* | Right annotation | The right the user must have to see the field.
7474
failWith | *no* | mixed | A value to return if the user is not authorized to see the field. If not specified, the field will not be visible at all to the user.

‎website/versioned_docs/version-4.0/annotations_reference.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `@Query` annotation is used to declare a GraphQL query.
1414
Attribute | Compulsory | Type | Definition
1515
---------------|------------|------|--------
1616
name | *no* | string | The name of the query. If skipped, the name of the method is used instead.
17-
[outputType](custom_output_types.md) | *no* | string | Forces the GraphQL output type of a query.
17+
[outputType](custom_types.md) | *no* | string | Forces the GraphQL output type of a query.
1818

1919
## @Mutation annotation
2020

@@ -62,7 +62,7 @@ The `@Field` annotation is used to declare a GraphQL field.
6262
Attribute | Compulsory | Type | Definition
6363
---------------|------------|------|--------
6464
name | *no* | string | The name of the field. If skipped, the name of the method is used instead.
65-
[outputType](custom_output_types.md) | *no* | string | Forces the GraphQL output type of a query.
65+
[outputType](type_mapping.md) | *no* | string | Forces the GraphQL output type of a query.
6666

6767
## @SourceField annotation
6868

@@ -73,7 +73,7 @@ The `@SourceField` annotation is used to declare a GraphQL field.
7373
Attribute | Compulsory | Type | Definition
7474
---------------|------------|------|--------
7575
name | *yes* | string | The name of the field.
76-
[outputType](custom_output_types.md) | *no* | string | Forces the GraphQL output type of the field. Otherwise, return type is used.
76+
[outputType](type_mapping.md) | *no* | string | Forces the GraphQL output type of the field. Otherwise, return type is used.
7777
phpType | *no* | string | The PHP type of the field (as you would write it in a Docblock)
7878
annotations | *no* | array<Annotations> | A set of annotations that apply to this field. You would typically used a "@Logged" or "@Right" annotation here.
7979

@@ -88,7 +88,7 @@ The `@MagicField` annotation is used to declare a GraphQL field that originates
8888
Attribute | Compulsory | Type | Definition
8989
---------------|------------|------|--------
9090
name | *yes* | string | The name of the field.
91-
[outputType](custom_output_types.md) | *no*(*) | string | The GraphQL output type of the field.
91+
[outputType](type_mapping.md) | *no*(*) | string | The GraphQL output type of the field.
9292
phpType | *no*(*) | string | The PHP type of the field (as you would write it in a Docblock)
9393
annotations | *no* | array<Annotations> | A set of annotations that apply to this field. You would typically used a "@Logged" or "@Right" annotation here.
9494

0 commit comments

Comments
 (0)