[DEV-847] Add changesets (#552)

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "privatePackages": {
+    "version": true,
+    "tag": true
+  }
+}

.github/workflows/changelog.yaml

@@ -0,0 +1,34 @@
+name: Changelog
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .changeset/** # Only on changes to ./changeset/*
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  changelog:
+    name: Update CHANGELOG
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - name: Setup Node.JS
+        uses: ./.github/actions/setup-node
+
+      - name: Install dependencies
+        run: npm ci --audit=false --fund=false
+
+      - name: Create PR for next release
+        uses: changesets/action@f13b1baaa620fde937751f5d2c3572b9da32af23 # v1.4.5
+        with:
+          # Note: `npm i` after versioning is necessary to refresh package-lock.json file with new version
+          version: npm run version && npm i
+          commit: "Update CHANGELOG and prepare next release"
+          title: "Bump version"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -88,3 +88,18 @@ Add to the package `<package>` the dependency `<dependency>` as `devDependencies
 ``` bash
 npm -w <package> install <dependency> -D
 ```
+
+## Changelog
+This project utilizes [changesets](https://github.com/changesets/changesets) to generate the changelog. Here's how you can use it:
+
+1. **Adding Changelog Information**: to add entries to the changelog, execute `npx changeset` or `npm run changeset`.  
+This will initiate a wizard that guides you through the process.
+
+2. **Defining the Change Type**: the wizard will ask you to specify the type of changes made (major, minor, patch).  
+The summary you provide here will be added to the `CHANGELOG.md` file. Follow the [semver](https://semver.org/#summary) specification in order to chose the prover type of change.
+
+3. **Generating the Changelog**: the [Changelog workflow](.github/workflows/changelog.yaml) uses the changeset's action to convert the changes tracked with `npm run changeset` into a `CHANGELOG.md` file.
+
+4. **Creating a Pull Request**: after generating the changelog, the workflow will create a PR with the proposed changes, which include version bumping and updating the `CHANGELOG.md` file.
+
+5. **Updating the PR**: if additional changes are made while the PR is open, the changeset's bot will automatically update the PR based on the changes in the `.changeset` folder.