Automate the process of generating release changelog, by using labels on PRs (#241)

Author: Andy2003

.github/workflows/changelog-configuration.json

@@ -0,0 +1,42 @@
+{
+  "max_tags_to_fetch": 200,
+  "max_pull_requests": 200,
+  "max_back_track_time_days": 365,
+  "exclude_merge_branches": [],
+  "sort": "ASC",
+  "template": "${{CHANGELOG}}",
+  "pr_template": "* ${{TITLE}} by @${{AUTHOR}} (#${{NUMBER}})",
+  "empty_template": "- no changes",
+  "categories": [
+    {
+      "title": "## Features",
+      "labels": ["feature", "enhancement"]
+    },
+    {
+      "title": "## API-Alignment\n\nAdjust API to match as much as possible to the one of [@neo4j/graphql](https://github.com/neo4j/graphql)",
+      "labels": ["API-Alignment"]
+    },
+    {
+      "title": "## Fixes",
+      "labels": ["fix"]
+    },
+    {
+      "title": "## Documentation",
+      "labels": ["doc"]
+    },
+    {
+      "title": "## Tests",
+      "labels": ["test"]
+    }
+  ],
+  "ignore_labels": [
+    "ignore", "dependencies"
+  ],
+  "label_extractor": [  ],
+  "duplicate_filter": null,
+  "transformers": [],
+  "tag_resolver": {
+    "method": "semver"
+  },
+  "base_branches": []
+}

.github/workflows/release-changelog.yaml

@@ -0,0 +1,31 @@
+name: Build release changelog
+
+on:
+  push:
+    tags :
+      - '*'
+jobs:
+  build:
+    name: Build Changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        with :
+          fetch-depth : 0
+      - name : Build Changelog
+        id : build_changelog
+        uses : mikepenz/release-changelog-builder-action@v1
+        with :
+          configuration : ".github/workflows/changelog-configuration.json"
+        env :
+          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
+      - name: update release
+        id: update_release
+        uses: tubone24/update_release@v1.2.0
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+          TAG_NAME: ${{steps.build_changelog.outputs.toTag}}
+        with:
+          release_name: Release ${{steps.build_changelog.outputs.toTag}}
+          body: ${{steps.build_changelog.outputs.changelog}}

readme.adoc

@@ -28,7 +28,7 @@ For complex examples take a look at our link:examples/readme.adoc[example projec
 
 == API compatibility to @neo4j/graphql
 
-Since the javascript pendant of this library (neo4j-graphql-js) has majored into a neo4j product, we want to migrate our augmented schema, to match as much as possible to the one of the https://github.com/neo4j/graphql-tracker-temp[`@neo4j/graphql`].
+Since the javascript pendant of this library (neo4j-graphql-js) has majored into a neo4j product, we want to migrate our augmented schema, to match as much as possible to the one of the https://github.com/neo4j/graphql[`@neo4j/graphql`].
 Therefore, we created a https://github.com/neo4j-graphql/neo4j-graphql-java/issues?q=label%3AAPI-Alignment[list of issues to track progress].
 
 We will try to make the migration as smooth as possible. For this purpose we will support the old, and the new way of schema augmentation until the next major release.