docs: add RELEASING.md

Author: josimar-silva

.github/workflows/spellcheck.yaml

@@ -6,12 +6,14 @@ on:
     paths:
       - "__posts/**"
       - "README.md"
+      - "RELEASING.md"
   push:
     branches:
       - main
     paths:
       - "__posts/**"
       - "README.md"
+      - "RELEASING.md"
 
 permissions:
   contents: read

.pyspelling.yaml

@@ -25,3 +25,4 @@ matrix:
     sources:
       - "__posts/**/*.md"
       - "README.md"
+      - "RELEASING.md"

RELEASING.md

@@ -0,0 +1,8 @@
+## Releasing
+
+These are the general steps to release a new package version:
+
+1. Run the following command `just prep-release`
+2. Open a pull request with the changes.
+3. Once the pull request is merged the Continuous Delivery workflow will build the release version, create the tag and create a draft [Github release](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) with the website and change notes.
+4. Review the draft GitHub release and, if everything is ok, release it.

justfile

@@ -49,3 +49,37 @@ test:
 test-ui:
 	npm run test-ui
 
+# Prepare for a new release
+pre-release:
+    #!/usr/bin/env bash
+    set -e
+
+    if [[ -n $(git status --porcelain) ]]; then
+      echo "Git working directory is not clean. Please commit or stash your changes."
+      exit 1
+    fi
+
+    echo "Running checks and tests..."
+    just check
+    just test
+    just test-ui
+
+    current_version=$(node -p "require('./package.json').version")
+    echo "Current version is ${current_version}"
+
+    if [[ $current_version != *"-SNAPSHOT"* ]]; then
+      echo "Error: Current version is not a SNAPSHOT version."
+      exit 1
+    fi
+
+    new_version=$(echo ${current_version} | sed 's/-SNAPSHOT//')
+    echo "Bumping version to ${new_version}..."
+    npm version --no-git-tag-version ${new_version}
+
+    echo "Committing version bump..."
+    git add package.json package-lock.json
+    git commit -m "chore(release): prepare for release v${new_version}"
+
+    echo "Pre-release for version ${new_version} is ready."
+    echo "You can now push the changes to trigger the release workflow."
+