chore: 🤖 initial changesets workflow for semver and changelogs (#760)

* chore: 🤖 add changesets pkg

* chore: 🤖 track .changeset

* chore: 🤖 add changeset:verify to pre-commit hook

* chore: 🤖 add changeset verification script

* docs: 📝  introduce changeset

* docs: 📝  how-to use changeset workflow

* docs: fix typo

Co-authored-by: Bucky Schwarz <d.w.schwarz@gmail.com>

* docs: fix typo

Co-authored-by: Bucky Schwarz <d.w.schwarz@gmail.com>

---------

Co-authored-by: Bucky Schwarz <d.w.schwarz@gmail.com>

Author: punkbit

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/deep-wolves-guess.md

@@ -0,0 +1,5 @@
+---
+"@clickhouse/click-ui": patch
+---
+
+Introduces a simple workflow to manage versioning and changelogs

.husky/pre-commit

@@ -26,5 +26,13 @@ else
   exit 1
 fi
 
+if yarn changeset:verify; then
+  echo "✅ Changeset file's included!"
+else
+  echo "⚠️ WARNING: You must include a changeset!"
+  echo "💡 Use the command yarn changeset:add"
+  exit 1
+fi
+
 echo "👍 Health check completed."
 echo

.scripts/changeset-verification

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+changesetArtifactsRegex="\.changeset/.*\.md$"
+
+pendingChangesetList=$(find .changeset -type f -name "*.md" ! -name "README.md")
+
+if [[ -n "$pendingChangesetList" ]]; then
+  echo "⚠️ There are pending changeset files:"
+  echo "$pendingChangesetList"
+fi
+
+if ! echo "$pendingChangesetList" | grep -qE "$changesetArtifactsRegex"; then
+  echo "👹 Oops! Couldn't locate any changeset. Did you forget to include one?"
+  echo "💡 Run the command yarn changeset:add"
+
+  exit 1
+fi
+
+echo "✅ Changeset included!"

README.md

@@ -146,6 +146,52 @@ function App() {
 export default App
 ```
 
+## Changeset
+
+Learn to manage the versioning of changelog entries.
+
+The following is a brief description of available commands to allow a person making a contribution make key decisions about their changes.
+
+It'll generate a changeset, which is effectively two key bits of information:
+
+- A version type which follows [semver](https://semver.org/)
+- Change information placed in a changelog
+
+Make good use of this simple workflow to help us release new package versions more confidently.
+
+### Add a new changeset
+
+When contributing, declare an intent or describe the changes you're making or adding to a release by executing the `changeset:add` command.
+
+The wizard will ask a few questions and generate a changelog entry for you:
+
+```sh
+yarn changeset:add
+```
+
+The changesets tool keeps track of all declared changes in the `.changeset` directory.
+
+Once completed, you must commit the changeset!
+
+### Checking the changeset status
+
+To check if your branch contains a changeset:
+
+```sh
+yarn changeset:status
+```
+
+### Create a new version and changelogs
+
+To consume all changesets, and update to the most appropriate semver version and write a friendly changelog based on those changesets, the following command is available:
+
+> [!IMPORTANT]
+> Consuming changesets is done automatically in the CI/CD environment. For this reason, you don't have to execute the command, as a contributor your single concern should be adding changesets to any relevant changes.
+
+```sh
+yarn changeset:version
+```
+
 ## Releases and Versions
 
 New versions and release notes are available at [GitHub Releases](https://github.com/ClickHouse/click-ui/releases).

package.json

@@ -37,6 +37,10 @@
     "build:bundled": "vite build -- bundled",
     "build-storybook": "storybook build",
     "build:watch": "watch 'yarn build' ./src",
+    "changeset:add": "yarn changeset",
+    "changeset:status": "yarn changeset status",
+    "changeset:version": "yarn changeset version",
+    "changeset:verify": ".scripts/changeset-verification",
     "chromatic": "yarn dlx chromatic",
     "dev": "vite",
     "generate-tokens": "node build-tokens.js && prettier --write \"src/theme/tokens/*.ts\" --config .prettierrc",
@@ -80,6 +84,7 @@
     "sortablejs": "^1.15.0"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.29.8",
     "@storybook/addon-a11y": "^10.1.10",
     "@storybook/addon-docs": "^10.1.10",
     "@storybook/addon-links": "^10.1.10",