From b75a7ddb7b1fb75d8b23955096cc6d66c8caa835 Mon Sep 17 00:00:00 2001
From: Daniel Chambers <daniel@hasura.io>
Date: Tue, 3 Sep 2024 17:14:10 +1000
Subject: [PATCH] Add changelog and a release pipeline (#35)

This PR adds a `CHANGELOG.md` file that reflects what's already been
added manually to the GitHub releases. It also adds a GitHub Workflow
that will create a GitHub release with the contents of the changelog
when a new version is tagged.
---
 .github/workflows/release.yaml | 30 ++++++++++++++++++++++++++++++
 CHANGELOG.md                   | 29 +++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 .github/workflows/release.yaml
 create mode 100644 CHANGELOG.md

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
new file mode 100644
index 0000000..20077b8
--- /dev/null
+++ b/.github/workflows/release.yaml
@@ -0,0 +1,30 @@
+name: release
+on:
+  push:
+    tags:
+      - v**
+
+jobs:
+  release-sdk:
+    name: Release SDK
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+
+    steps:
+      - name: Get version from tag
+        id: get-version
+        run: |
+          echo "tagged_version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+        shell: bash
+
+      - uses: mindsers/changelog-reader-action@v2
+        id: changelog-reader
+        with:
+          version: ${{ steps.get-version.outputs.tagged_version }}
+          path: ./CHANGELOG.md
+
+      - uses: softprops/action-gh-release@v2
+        with:
+          draft: false
+          tag_name: v${{ steps.get-version.outputs.tagged_version }}
+          body: ${{ steps.changelog-reader.outputs.changes }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..57da424
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,29 @@
+# NDC TypeScript SDK Changelog
+
+This changelog documents the changes between release versions.
+
+## [Unreleased]
+
+Changes to be included in the next upcoming release
+
+## [0.4.0] - 2024-08-30
+
+- update ndc-spec to v0.1.6 by @soupi in https://github.com/hasura/ndc-sdk-rs/pull/28
+
+## [0.3.0] - 2024-08-12
+
+- Health checks are now readiness checks; they should not make requests to any external services. We will revisit liveness and connectedness checks in a future release.
+- The `/health` endpoint is now unsecured.
+
+## [0.2.2] - 2024-07-30
+
+- listen on all ipv4 and ipv6 interfaces by default (https://github.com/hasura/ndc-sdk-rs/pull/22)
+
+## [0.2.1] - 2024-07-11
+
+- Fix dynamic error types not being thread-safe
+
+## [0.2.0] - 2024-07-09
+
+- Update to `ndc-spec` v0.1.5
+- Changed `get_capabilities` method in `Connector` trait so that `ndc-spec` version is obtained directly from the `ndc-spec` package instead of requiring the connector to specify it.