chore: Added a release-workflow (#48)

* chore: Added a release-workflow

* fixup! chore: Added a release-workflow

Author: christian-kreuzberger-dtx

.github/workflows/main.yml

@@ -10,16 +10,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+
     - name: Use Node.js # will read version from .nvmrc
       uses: actions/setup-node@v4
       with:
         node-version-file: '.nvmrc'
-    # install packages
+
     - name: Install dependencies
       run: npm ci
-    # run tests
+
     - name: Test
       run: npm run test
-    # build the package
+
     - name: Build
       run: npm run build

.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'  # Triggers on version tags like v1.0.0, v2.1.3, etc.
+
+permissions:
+  contents: write  # Required for creating releases
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch full history for changelog generation
+
+      - name: Use Node.js # will read version from .nvmrc
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm run test
+
+      - name: Build
+        run: npm run build
+
+      - name: Extract version from tag
+        id: version
+        run: |
+          # Remove 'v' prefix from tag to get version
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+
+      - name: Generate changelog for GitHub Release
+        id: changelog
+        run: |
+          # Get the previous tag
+          PREV_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
+
+          # Generate changelog between tags
+          if [ -n "$PREV_TAG" ]; then
+            CHANGELOG=$(git log --pretty=format:"- %s (%h)" $PREV_TAG..HEAD)
+          else
+            CHANGELOG=$(git log --pretty=format:"- %s (%h)")
+          fi
+
+          # Save changelog to output (handle multiline)
+          echo "changelog<<EOF" >> $GITHUB_OUTPUT
+          echo "$CHANGELOG" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          # Create release body
+          cat > release_body.md << 'EOF'
+          ## Changes in ${{ steps.version.outputs.tag }}
+
+          ${{ steps.changelog.outputs.changelog }}
+
+          ## Installation
+
+          ```bash
+          npm install @dynatrace-oss/dynatrace-mcp-server@${{ steps.version.outputs.version }}
+          ```
+          EOF
+
+          # Create the release
+          if [[ "${{ steps.version.outputs.version }}" == *"-"* ]]; then
+            gh release create "${{ steps.version.outputs.tag }}" \
+              --title "Release ${{ steps.version.outputs.tag }}" \
+              --notes-file release_body.md \
+              --prerelease
+          else
+            gh release create "${{ steps.version.outputs.tag }}" \
+              --title "Release ${{ steps.version.outputs.tag }}" \
+              --notes-file release_body.md
+          fi

RELEASE.md

@@ -0,0 +1,53 @@
+# Release Process
+
+This repository uses automated GitHub workflows to prepare releases whenever a new tag is pushed.
+
+## How it works
+
+1. When you push a tag starting with `v` (e.g., `v1.0.0`, `v2.1.3`), the release workflow automatically triggers
+2. The workflow builds the project, runs tests, and creates a GitHub release with auto-generated release notes
+
+**Note**: This workflow does (not yet) publish the release to npmjs.com.
+
+## Creating a Release
+
+### Manual tagging
+
+```bash
+# Make sure you're on the main branch and have latest changes
+git checkout main
+git pull origin main
+
+# Run tests and build locally (optional but recommended)
+npm test
+npm run build
+
+# Create and push a tag
+git tag vx.y.z  # Replace with your desired version
+git push origin vx.y.z
+```
+
+After pushing the tag, the workflow will automatically:
+1. Run tests
+2. Build the project
+3. Generate release notes from commit history
+4. Create a GitHub release
+
+### Creating Pre-releases
+
+For beta or alpha releases:
+
+```bash
+# Create a pre-release tag
+git tag vx.y.z-beta.1
+git push origin vx.y.z-beta.1
+```
+
+Pre-releases will be automatically marked as such in the GitHub release.
+
+## Release Notes
+
+The workflow automatically generates technical release notes by collecting all commit messages between the current and previous tag. The release notes include:
+
+- A list of changes with commit hashes
+- Proper pre-release marking for beta/alpha versions