Merge remote-tracking branch 'upstream/6.x' into remove-ogm-docs

Author: MacondoExpress

.backportrc.json

@@ -0,0 +1,5 @@
+{
+    "repoOwner": "Neo4j",
+    "repoName": "docs-graphql",
+    "prTitle": "[Cherry-pick][{{targetBranch}}] {{commitMessages}}"
+  }

.github/workflows/auto-backport.yml

@@ -0,0 +1,31 @@
+name: auto-cherry-pick
+on:
+  pull_request_target:
+    types: ["labeled", "closed"]
+
+jobs:
+  backport:
+    name: Cherry-pick PR
+    runs-on: [ubuntu-latest]
+    if: |
+      github.event.pull_request.merged == true
+      && contains(github.event.pull_request.labels.*.name, 'auto-cherry-pick')
+      && (
+        (github.event.action == 'labeled' && github.event.label.name == 'auto-cherry-pick')
+        || (github.event.action == 'closed')
+      )
+    steps:
+      - name: Cherry-pick action
+        uses: sorenlouv/backport-github-action@929f69d04adbc196d982e60f02837b6cc00b3129
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          auto_backport_label_prefix: auto-cherry-pick-to-
+          add_original_reviewers: true
+
+      - name: Info log
+        if: ${{ success() }}
+        run: cat ~/.backport/backport.info.log
+
+      - name: Debug log
+        if: ${{ failure() }}
+        run: cat ~/.backport/backport.debug.log

README.adoc

@@ -1,8 +1,8 @@
-= Neo4j GraphQL Library
+= Neo4j GraphQL library docs
 
 This repo contains the documentation for the Neo4j GraphQL Library.
 
-== Prereqs
+== Prerequisites
 
 - link:https://nodejs.org/en/download/[Node.js]
 - npm
@@ -113,3 +113,33 @@ When we publish preview content to either development or production environments
 
 You can use the link:https://www.npmjs.com/package/@neo4j-antora/antora-add-notes[antora-add-notes] extension to add content to your pages.
 Follow the Usage instructions in the package documentation.
+
+== Repository and pull requests
+
+=== Enable automatic cherry-picking on a PR
+
+To enable automatic cherry-picking on a PR, add the label `auto-cherry-pick` to it.
+Without it, the responsible GitHub action is not going to be triggered.
+
+To select the target branches you would like to cherry-pick your PR to, add labels of the following structure: `auto-cherry-pick-to-<targetBranch>`.
+For example: `auto-cherry-pick-to-6.x` to cherry-pick it to the branch `6.x` or `auto-cherry-pick-to-5.x` for the branch `5.x`.
+You may even add new labels for branches that do not have such a label yet.
+
+The feature is triggered by either merging a PR with the `auto-cherry-pick` label or by adding the `auto-cherry-pick` label to an already closed and merged PR.
+In the latter case, ensure that you first add the labels containing the target branches and then finally the `auto-cherry-pick` label.
+Otherwise the automation starts without any target branches.
+
+==== Details
+
+The PRs created by this GitHub action will have their heading prefixed with `[Cherry-pick][<targetBranch>]`.
+So, for example, for `6.x` as the target branch and `some changes` as the original PR heading, it results in `[Cherry-pick][6.x] some changes` as the heading for the cherry-picked PR.
+In case an assignee was set for the original PR, the cherry-picked PRs will also receive the same assignee.
+You must add reviewers manually after the cherry-picked PRs have been created.
+
+The creation of cherry-picked PRs can take a few minutes.
+If you are an assignee of the original PR, you receive an email notification once the cherry-picked PRs have been created.
+The original PR is updated with a comment that contains links to the newly created cherry-picked PRs.
+
+In case of a merge conflict while cherry-picking to a specific release branch, the branch will be skipped. Information on skipped branches is also included in the comment added to the original PR.
+In that case you will have to take care of cherry-picking manually and resolve the conflicts.
+This is not going to influence the other release branches as long as they do not have conflicts.

modules/ROOT/pages/directives/autogeneration.adoc

@@ -31,7 +31,7 @@ The following type definition specifies the `id` field as an autogenerated value
 
 [source, graphql, indent=0]
 ----
-type User {
+type User @node {
     id: ID! @id
     username: String!
 }
@@ -70,7 +70,7 @@ The following type definition has two individual fields to store the timestamps
 
 [source, graphql, indent=0]
 ----
-type User {
+type User @node {
     createdAt: DateTime! @timestamp(operations: [CREATE])
     updatedAt: DateTime! @timestamp(operations: [UPDATE])
 }
@@ -80,14 +80,14 @@ The following two equivalent type definitions have a single field storing the ev
 
 [source, graphql, indent=0]
 ----
-type User {
+type User @node {
     lastModified: DateTime! @timestamp
 }
 ----
 
 [source, graphql, indent=0]
 ----
-type User {
+type User @node {
     lastModified: DateTime! @timestamp(operations: [CREATE, UPDATE])
 }
 ----

modules/ROOT/pages/directives/custom-directives.adoc

@@ -57,7 +57,7 @@ const neoSchema = new Neo4jGraphQL({
     typeDefs: [
         upperDirectiveTypeDefs,
         `#graphql
-            type Movie {
+            type Movie @node {
                 name: String @uppercase
             }
         `,

modules/ROOT/pages/directives/custom-logic.adoc

@@ -47,7 +47,7 @@ interface Auth {
 a| You can use the JWT in the request to return the value of the currently logged in User:
 [source, graphql, indent=0]
 ----
-type User {
+type User @node {
     id: String
 }
 
@@ -117,7 +117,7 @@ Both approaches are demonstrated here:
 
 [source, graphql, indent=0]
 ----
-type User {
+type User @node {
     id
 }
 
@@ -135,7 +135,7 @@ type Query {
 
 [source, graphql, indent=0]
 ----
-type User {
+type User @node {
     id
 }
 
@@ -185,13 +185,13 @@ In the following example, the field `similarMovies` is bound to the `Movie` type
 
 [source, graphql, indent=0]
 ----
-type Actor {
+type Actor @node {
     actorId: ID!
     name: String
     movies: [Movie!]! @relationship(type: "ACTED_IN", direction: OUT)
 }
 
-type Movie {
+type Movie @node {
     movieId: ID!
     title: String
     description: String
@@ -216,7 +216,7 @@ The following example demonstrates a query to return all of the actors in the da
 
 [source, graphql, indent=0]
 ----
-type Actor {
+type Actor @node {
     actorId: ID!
     name: String
 }
@@ -239,7 +239,7 @@ The following example demonstrates a mutation using a Cypher query to insert a s
 
 [source, graphql, indent=0]
 ----
-type Actor {
+type Actor @node {
     actorId: ID!
     name: String
 }
@@ -291,7 +291,7 @@ enum Status {
     ACTIVE
     INACTIVE
 }
-type Movie {
+type Movie @node {
     status: Status @coalesce(value: ACTIVE)
 }
 ----
@@ -345,7 +345,7 @@ Take, for instance, this schema:
 [source, javascript, indent=0]
 ----
 const typeDefs = `
-    type User {
+    type User @node {
         firstName: String!
         lastName: String!
         fullName: String! @customResolver(requires: "firstName lastName")
@@ -397,13 +397,13 @@ Using a selection set string makes it possible to select fields from related typ
 [source, javascript, indent=0]
 ----
 const typeDefs = `
-    type Address {
+    type Address @node {
         houseNumber: Int!
         street: String!
         city: String!
     }
 
-    type User {
+    type User @node {
         id: ID!
         firstName: String!
         lastName: String!
@@ -437,7 +437,7 @@ interface Publication {
     publicationYear: Int!
 }
 
-type Author {
+type Author @node {
     name: String!
     publications: [Publication!]! @relationship(type: "WROTE", direction: OUT)
     publicationsWithAuthor: [String!]!
@@ -446,13 +446,13 @@ type Author {
         )
 }
 
-type Book implements Publication {
+type Book implements Publication @node {
     title: String!
     publicationYear: Int!
     author: [Author!]! @relationship(type: "WROTE", direction: IN)
 }
 
-type Journal implements Publication {
+type Journal implements Publication @node {
     subject: String!
     publicationYear: Int!
     author: [Author!]! @relationship(type: "WROTE", direction: IN)
@@ -468,7 +468,7 @@ interface Publication {
     publicationYear: Int!
 }
 
-type Author {
+type Author @node {
     name: String!
     publications: [Publication!]! @relationship(type: "WROTE", direction: OUT)
     publicationsWithAuthor: [String!]!
@@ -477,13 +477,13 @@ type Author {
         )
 }
 
-type Book implements Publication {
+type Book implements Publication @node {
     title: String!
     publicationYear: Int!
     author: [Author!]! @relationship(type: "WROTE", direction: IN)
 }
 
-type Journal implements Publication {
+type Journal implements Publication @node {
     subject: String!
     publicationYear: Int!
     author: [Author!]! @relationship(type: "WROTE", direction: IN)
@@ -525,7 +525,7 @@ Type definitions:
 
 [source, graphql, indent=0]
 ----
-type Product {
+type Product @node {
     name: String!
     slug: String! @populatedBy(callback: "slug", operations: [CREATE, UPDATE])
 }
@@ -561,7 +561,7 @@ For example, if you want a field `modifiedBy`:
 
 [source, graphql, indent=0]
 ----
-type Record {
+type Record @node {
     content: String!
     modifiedBy: @populatedBy(callback: "modifiedBy", operations: [CREATE, UPDATE])
 }