vbump: 0.0.1-beta

.gitattributes

@@ -0,0 +1 @@
+* text eol=crlf

.github/workflows/cd-1.yml

@@ -0,0 +1,282 @@
+name: CD 1
+
+# This workflow supports the first phase of delvier process, when a PR is opened pointing [main] branch, will trigger validations.
+# First will check if all PR opened to [main] are from [dev].
+# Then will check that package metadata version was bumped correctly.
+
+on:
+  workflow_dispatch:
+
+  pull_request:
+    branches: 
+        - main
+    types:
+        - opened
+        - reopened
+        - synchronize
+
+permissions: 
+  contents: write
+
+jobs:
+
+  validate-source:
+    name: Validate Source Branch
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Prevent Sources 
+        run: |
+          set -euo pipefail
+          HEAD_REF="${{ github.head_ref }}"
+          echo "Head Branch: $HEAD_REF"
+
+          if [ "$HEAD_REF" = "dev" ]; then
+            echo "Cannot merge into main from dev branch"
+            exit 1
+          fi
+
+          if [[ "$HEAD_REF" =~ ^vbump_[0-9]+\.[0-9]+\.[0-9]+(-[A-Za-z0-9._-]+)?$ ]]; then
+            echo "Name matches version bump"
+            exit 0
+          else
+            echo "Wrong source. Expected: vbump_{version}"
+            exit 1
+          fi
+
+  compare-versions: 
+    needs: validate-source
+    name: Compare Versions 
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.package_metadata.outputs.version }}
+      packages: ${{ steps.package_metadata.outputs.packages }}
+
+    steps: 
+      - name: CheckOut Base 
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.base.ref }}
+          path: base
+
+      - name: CheckOut Head
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          path: head
+
+      - name: Read Base version
+        id: base_version
+        run: |
+          VERSION=$(jq -r '.version' base/csmpackage.json)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Read Head version
+        id: head_version
+        run: |
+          VERSION=$(jq -r '.version' head/csmpackage.json)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Compare versions
+        run: |
+          BASE="${{ steps.base_version.outputs.version }}"
+          HEAD="${{ steps.head_version.outputs.version }}"
+
+          echo "Base version: $BASE"
+          echo "Head version: $HEAD"
+
+          if [ "$BASE" = "$HEAD" ]; then
+            echo "Package metadata versions are not bumped"
+            exit 1
+          fi
+
+          echo "Versions bumped correctly"
+
+      - name: Expose Package Metadata
+        id: package_metadata
+        run: |
+          VERSION=$(jq -r '.version' head/csmpackage.json)
+          PACKAGES_JSON=$(jq -c '.packages' head/csmpackage.json)
+
+          printf '%s\n' "version=$VERSION" >> $GITHUB_OUTPUT
+          printf '%s\n' "packages=$PACKAGES_JSON" >> $GITHUB_OUTPUT
+
+  generate_release_docs:
+    name: Generate Release Documentation (Release-Notes & Changelog)
+    needs: compare-versions
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package: ${{ fromJson(needs.compare-versions.outputs.packages) }}
+    steps:
+      - name: CheckOut Head branch
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: SetUp GitHub Access
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+
+      - name: Prepare Package Metadata
+        run: |
+          echo "PACKAGE='${{ matrix.package }}'"
+          echo "VERSION='${{ needs.compare-versions.outputs.version }}'"
+        shell: bash
+
+      - name: Generate release notes and update CHANGELOG
+        id: gen_docs
+        run: |
+          set -euo pipefail
+
+          PACKAGE="${{ matrix.package }}"
+          VERSION="${{ needs.compare-versions.outputs.version }}"
+
+          # Derive package path (preserve full path if matrix.package is a path)
+          PACKAGE_PATH="$PACKAGE"
+          # If matrix.package contains a repo-like "dir/subdir", keep it as-is.
+          # Release notes directory and file
+          RELEASE_DIR="$PACKAGE_PATH/release-notes"
+          RELEASE_FILE="$RELEASE_DIR/v${VERSION}.md"
+
+          echo "Package path: $PACKAGE_PATH"
+          echo "Release notes file: $RELEASE_FILE"
+
+          mkdir -p "$RELEASE_DIR"
+
+          # Build release notes content
+          {
+            echo "## Release $VERSION"
+            echo ""
+            echo "### Commits included"
+            echo ""
+          } > "$RELEASE_FILE"
+
+          BASE_SHA="${{ github.event.pull_request.base.sha }}"
+          HEAD_SHA="${{ github.event.pull_request.head.sha }}"
+
+          if [ -z "$BASE_SHA" ] || [ -z "$HEAD_SHA" ]; then
+            echo "- Unable to determine commit range." >> "$RELEASE_FILE"
+          else
+            # If there are no commits in range, note it; otherwise list commits
+            if [ "$(git rev-list --count "$BASE_SHA..$HEAD_SHA")" -eq 0 ]; then
+              echo "- No commits detected between base and head." >> "$RELEASE_FILE"
+            else
+              git --no-pager log --pretty=format:"- %s (%an)" "$BASE_SHA..$HEAD_SHA" >> "$RELEASE_FILE"
+            fi
+          fi
+
+          echo "Wrote release notes to $RELEASE_FILE"
+
+          # Ensure CHANGELOG exists at package root
+          CHANGELOG_FILE="$PACKAGE_PATH/CHANGELOG"
+          if [ ! -f "$CHANGELOG_FILE" ]; then
+            echo "Creating new CHANGELOG at $CHANGELOG_FILE"
+            echo "# Changelog" > "$CHANGELOG_FILE"
+            echo "" >> "$CHANGELOG_FILE"
+          fi
+
+          # Prepare new changelog entry content (you can customize the header/body format)
+          NEW_ENTRY_FILE="$(mktemp)"
+          {
+            echo "## v${VERSION}"
+            echo ""
+            echo "### Release notes"
+            echo ""
+            # Insert the same commit list into the changelog entry
+            sed -n '1,200000p' "$RELEASE_FILE" | sed '1,2d'  # skip the top two lines already added above
+            echo ""
+          } > "$NEW_ENTRY_FILE"
+
+          # Replace existing entry for this version if present, otherwise prepend new entry after top header
+          # We treat entries as starting with a line that matches '^## v<version>'
+          if grep -qE "^## v${VERSION}\b" "$CHANGELOG_FILE"; then
+            echo "Found existing CHANGELOG entry for v${VERSION}, replacing it."
+            # Use awk to replace the section starting at "## vVERSION" up to the next "## v" or EOF
+            awk -v ver="v${VERSION}" -v newfile="$NEW_ENTRY_FILE" '
+              BEGIN {
+                replaced = 0;
+                while ((getline line < newfile) > 0) {
+                  newlines = newlines line "\n"
+                }
+                close(newfile)
+              }
+              {
+                if ($0 ~ "^## " ver "\\b") {
+                  # print newlines and skip until next "## v" or EOF
+                  printf "%s", newlines
+                  replaced = 1
+                  # skip lines until next "## v" header
+                  while (getline > 0) {
+                    if ($0 ~ "^## v[0-9]+") {
+                      print $0
+                      break
+                    }
+                  }
+                  next
+                }
+                print $0
+              }
+              END {
+                if (replaced == 0) {
+                  # no replacement happened; print nothing here (caller will handle prepend)
+                }
+              }
+            ' "$CHANGELOG_FILE" > "${CHANGELOG_FILE}.tmp" || true
+
+            # If awk produced a tmp file with content, move it back; otherwise fall back to prepend
+            if [ -s "${CHANGELOG_FILE}.tmp" ]; then
+              mv "${CHANGELOG_FILE}.tmp" "$CHANGELOG_FILE"
+            else
+              # fallback: prepend
+              cat "$NEW_ENTRY_FILE" "$CHANGELOG_FILE" > "${CHANGELOG_FILE}.tmp"
+              mv "${CHANGELOG_FILE}.tmp" "$CHANGELOG_FILE"
+            fi
+          else
+            echo "No existing entry for v${VERSION}. Prepending new entry to CHANGELOG."
+            # Prepend new entry after the top-level header if present, otherwise at top
+            # If file starts with "# Changelog", keep it and insert after that header
+            if head -n1 "$CHANGELOG_FILE" | grep -qE '^#\s+Changelog'; then
+              # keep header line, then insert new entry
+              tail -n +2 "$CHANGELOG_FILE" > "${CHANGELOG_FILE}.body.tmp"
+              { head -n1 "$CHANGELOG_FILE"; echo ""; cat "$NEW_ENTRY_FILE"; echo ""; cat "${CHANGELOG_FILE}.body.tmp"; } > "${CHANGELOG_FILE}.tmp"
+              mv "${CHANGELOG_FILE}.tmp" "$CHANGELOG_FILE"
+              rm -f "${CHANGELOG_FILE}.body.tmp"
+            else
+              # no top header, just prepend
+              cat "$NEW_ENTRY_FILE" "$CHANGELOG_FILE" > "${CHANGELOG_FILE}.tmp"
+              mv "${CHANGELOG_FILE}.tmp" "$CHANGELOG_FILE"
+            fi
+          fi
+
+          rm -f "$NEW_ENTRY_FILE"
+
+          echo "Updated CHANGELOG at $CHANGELOG_FILE"
+
+          # Expose whether there are changes to commit
+          if git status --porcelain | grep -q .; then
+            echo "changes=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "changes=false" >> "$GITHUB_OUTPUT"
+          fi
+        shell: bash
+
+      - name: Commit Generated vdocs
+        if: steps.gen_docs.outputs.changes == 'true'
+        run: |
+          set -euo pipefail
+          git add -A
+          # Use exact commit title requested
+          git commit -m "Generated vdocs."
+          git push origin HEAD:${{ github.event.pull_request.head.ref }}
+          echo "Pushed commit 'Generated vdocs.' to branch ${{ github.event.pull_request.head.ref }}"
+        shell: bash
+
+      - name: No changes to commit
+        if: steps.gen_docs.outputs.changes == 'false'
+        run: echo "No release docs changes detected; nothing to commit."
+
+