Merge pull request #10 from opf/impl/66324-automatic-release-on-new-version

automatically create a new release when a new version is merged to thee main branch

Author: brunopagno

.github/workflows/tag-version.yml

@@ -0,0 +1,32 @@
+name: Tag Version
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  tag-version:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # fetch all tags
+
+      - name: Tag and push if new version
+        run: |
+          VERSION=$(jq -r .version package.json)
+          TAG="v$VERSION"
+          if git rev-parse "$TAG" >/dev/null 2>&1; then
+            echo "Tag $TAG already exists. No action taken."
+          else
+            git config user.name "github-actions[bot]"
+            git config user.email "github-actions[bot]@users.noreply.github.com"
+            git tag "$TAG"
+            git push origin "$TAG"
+            echo "Tag $TAG created and pushed."
+          fi

README.md

@@ -4,6 +4,16 @@
 
 ## Usage
 
+### Installation
+
+Include the following entry to your _package.json_.
+
+```json
+"op-blocknote-extensions": "github:opf/op-blocknote-extensions#<VERSION>"
+```
+
+### Implementation
+
 First setup a blocknote schema with additional blocks offered by this library...
 
 ```jsx
@@ -81,8 +91,6 @@ This should make sure that the package is available for OpenProject even if runn
 
 ### Releases
 
-Releases and versioning are not implemented yet. For now the way to use this library is by including the following entry directly to the _package.json_ of your application.
+Updating the version field in package.json will automatically create a new Git tag with the corresponding version. Pushing this tag to the repository triggers the generation of a new release.
 
-```json
-"op-blocknote-extensions": "github:opf/op-blocknote-extensions"
-```
+To publish a new release, simply update the version in package.json and merge the changes into the main branch.