🔄 Preview: Update tyk-self-managed.mdx

.github/test-events/issue_comment.json

@@ -0,0 +1,26 @@
+{
+  "action": "created",
+  "issue": {
+    "number": 234,
+    "pull_request": {
+      "url": "https://api.github.com/repos/TykTechnologies/tyk-docs/pulls/234"
+    }
+  },
+  "comment": {
+    "body": "/release to release-5.8",
+    "user": {
+      "login": "test-user"
+    }
+  },
+  "repository": {
+    "name": "mintlify-poc",
+    "full_name": "TykTechnologies/mintlify-poc",
+    "default_branch": "main",
+    "owner": {
+      "login": "TykTechnologies"
+    }
+  },
+  "sender": {
+    "login": "test-user"
+  }
+}

.github/workflows/mirror-pr-to-build-deploy.yml

@@ -28,52 +28,38 @@ jobs:
             # Create new mirror PR
             echo "Creating new mirror PR..."
 
-            # Create PR body content
-            PR_BODY="**🔗 Auto-generated mirror PR for Mintlify preview**
+            # Create PR body content using printf to avoid shell parsing issues
+            printf '%s\n' \
+              "**🔗 Auto-generated mirror PR for Mintlify preview**" \
+              "" \
+              "**Original PR:** #${{ github.event.number }}" \
+              "**Author:** @${{ github.event.pull_request.user.login }}" \
+              "" \
+              "## Purpose" \
+              "This PR provides a Mintlify preview link for reviewing documentation changes." \
+              "" \
+              "## Preview Link" \
+              "The Mintlify preview will be available once this PR is processed." \
+              "" \
+              "## ⚠️ Important Notes" \
+              "- **Do not merge this PR directly**" \
+              "- This PR will be auto-merged when the original PR #${{ github.event.number }} is merged" \
+              "- Make all comments and reviews on the original PR #${{ github.event.number }}" \
+              "" \
+              "## Changes" \
+              "${{ github.event.pull_request.body }}" > pr_body.txt
 
-            **Original PR:** #${{ github.event.number }}
-            **Author:** @${{ github.event.pull_request.user.login }}
+            # Escape the title properly to handle special characters and spaces
+            ESCAPED_TITLE=$(printf '%s' "🔄 Preview: ${{ github.event.pull_request.title }}" | sed 's/"/\\"/g')
 
-            ## Purpose
-            This PR provides a Mintlify preview link for reviewing documentation changes.
-
-            ## Preview Link
-            The Mintlify preview will be available once this PR is processed.
-
-            ## ⚠️ Important Notes
-            - **Do not merge this PR directly**
-            - This PR will be auto-merged when the original PR #${{ github.event.number }} is merged
-            - Make all comments and reviews on the original PR #${{ github.event.number }}
-
-            ## Changes
-            ${{ github.event.pull_request.body }}"
-
             gh pr create \
               --base production \
-              --head ${{ github.head_ref }} \
-              --title "🔄 Preview: ${{ github.event.pull_request.title }}" \
-              --body "$PR_BODY"
+              --head "${{ github.head_ref }}" \
+              --title "$ESCAPED_TITLE" \
+              --body-file pr_body.txt \
+              --draft
 
             echo "✅ Mirror PR created successfully"
-
-            # Get the mirror PR number that was just created
-            MIRROR_PR=$(gh pr list --base production --head ${{ github.head_ref }} --json number --jq '.[0].number // empty')
-
-            # Comment on the original PR with link to mirror PR
-            if [ -n "$MIRROR_PR" ]; then
-              COMMENT_BODY="🔗 **Preview Link Available**
-
-              This PR has an auto-generated mirror for Mintlify preview:
-              👉 **[View Preview PR #$MIRROR_PR](https://github.com/${{ github.repository }}/pull/$MIRROR_PR)**
-
-              The Mintlify preview link will appear on the mirror PR once it's processed.
-
-              ---
-              *This is an automated comment. All discussion should happen on this PR, not the mirror PR.*"
-
-              gh pr comment ${{ github.event.number }} --body "$COMMENT_BODY"
-              echo "✅ Comment added to original PR with mirror PR link"
-            fi
           else
             echo "🔄 Mirror PR #$MIRROR_PR already exists and will be auto-updated"
           fi

.github/workflows/release-bot.yaml

@@ -0,0 +1,189 @@
+name: Cherry-pick to Release Branch
+
+on:
+  issue_comment:
+    types: [created]
+  workflow_call:
+
+jobs:
+  cherry_pick:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for release command
+        id: check_command
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const { issue, comment } = context.payload;
+            if (!issue || !issue.pull_request || !comment || !comment.body.startsWith('/release to ')) {
+              core.setOutput('release_valid', 'false');
+              return;
+            }
+            const releaseBranch = comment.body.split('/release to ')[1].trim();
+            core.setOutput('release_valid', 'true');
+            core.setOutput('release_branch', releaseBranch);
+            core.setOutput('pr_number', issue.number);
+
+      - name: Check admin permissions
+        if: steps.check_command.outputs.release_valid == 'true'
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const username = context.payload.comment.user.login;
+            const authorAssociation = context.payload.comment.author_association;
+
+            // Quick check: Repository owner always allowed
+            if (authorAssociation === 'OWNER') {
+              console.log(`✅ User ${username} is repository owner`);
+              return;
+            }
+
+            // Check for admin permission
+            try {
+              const { data: permission } = await github.rest.repos.getCollaboratorPermissionLevel({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                username: username
+              });
+
+              if (permission.permission !== 'admin') {
+                core.setFailed(`❌ Only repository admins can use /release command. User ${username} has: ${permission.permission}`);
+                return;
+              }
+
+              console.log(`✅ User ${username} has admin permissions`);
+            } catch (error) {
+              core.setFailed(`❌ Permission check failed: ${error.message}`);
+            }
+
+      - name: Install GitHub CLI (for act/local testing)
+        if: steps.check_command.outputs.release_valid == 'true'
+        run: |
+          sudo apt update
+          sudo apt install -y curl unzip gnupg
+          curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo tee /usr/share/keyrings/githubcli-archive-keyring.gpg >/dev/null
+          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
+          sudo apt update
+          sudo apt install -y gh
+
+      - name: Checkout repository
+        if: steps.check_command.outputs.release_valid == 'true'
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set default branch variable
+        if: steps.check_command.outputs.release_valid == 'true'
+        run: echo "DEFAULT_BRANCH=${{ github.event.repository.default_branch }}" >> $GITHUB_ENV
+
+      - name: Skip jobs if not a valid release command
+        if: steps.check_command.outputs.release_valid == 'false'
+        run: echo "Skipping cherry-pick as the release command is not valid."
+        continue-on-error: true
+
+      - name: Setup Git
+        if: steps.check_command.outputs.release_valid == 'true'
+        run: |
+          git config --global user.email "bot@tyk.io"
+          git config --global user.name "Tyk Bot"
+
+      - name: Get PR base and merge SHAs
+        id: pr_details
+        if: steps.check_command.outputs.release_valid == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          PR_NUMBER=${{ steps.check_command.outputs.pr_number }}
+          MERGE_COMMIT=$(gh pr view "$PR_NUMBER" --json mergeCommit --jq '.mergeCommit.oid // empty')
+          BASE_SHA=$(gh pr view "$PR_NUMBER" --json baseRefOid --jq '.baseRefOid // empty')
+          echo "MERGE_COMMIT=$MERGE_COMMIT" >> $GITHUB_ENV
+          echo "BASE_SHA=$BASE_SHA" >> $GITHUB_ENV
+          echo "MERGE_COMMIT=$MERGE_COMMIT" >> $GITHUB_OUTPUT
+          echo "BASE_SHA=$BASE_SHA" >> $GITHUB_OUTPUT
+
+      - name: Cherry-pick PR into release branch
+        id: cherry_pick
+        if: steps.check_command.outputs.release_valid == 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.ORG_GH_TOKEN }}
+          GITHUB_REPO: ${{ github.repository }}
+          GITHUB_BRANCH: ${{ steps.check_command.outputs.release_branch }}
+        run: |
+          export FOLDER=$(basename "$GITHUB_REPO")
+          rm -rf $FOLDER
+          git clone https://x-access-token:$GITHUB_TOKEN@github.com/$GITHUB_REPO
+          cd $FOLDER
+
+          git checkout $GITHUB_BRANCH
+          git pull
+
+          NEW_BRANCH=merge/$GITHUB_BRANCH/$MERGE_COMMIT
+          git branch -D $NEW_BRANCH 2>/dev/null || true
+          REMOTE_EXISTS=$(git ls-remote --heads origin $NEW_BRANCH | wc -l)
+          [ "$REMOTE_EXISTS" -gt 0 ] && git push origin --delete $NEW_BRANCH || true
+
+          git checkout -b $NEW_BRANCH
+
+          MERGE_FAILED=0
+          git cherry-pick -x $BASE_SHA..$MERGE_COMMIT || MERGE_FAILED=$?
+
+          git diff --quiet origin/$GITHUB_BRANCH HEAD && {
+            echo "No changes to cherry-pick"
+            echo "PR_URL=" >> $GITHUB_OUTPUT
+            echo "MERGE_FAILED=0" >> $GITHUB_OUTPUT
+            exit 0
+          }
+
+          git push origin $NEW_BRANCH --force
+
+          TITLE=$(git log --format=%s -n 1 $MERGE_COMMIT)
+          BODY=$(git log --format=%B -n 1 $MERGE_COMMIT)
+
+          PR_URL=$(gh pr create \
+            --title "Merging to $GITHUB_BRANCH: $TITLE" \
+            --body "$BODY" \
+            --repo $GITHUB_REPO \
+            --base $GITHUB_BRANCH \
+            --head $NEW_BRANCH \
+            $( [ "$MERGE_FAILED" -ne 0 ] && echo "--draft" ))
+
+          echo "PR_URL=$PR_URL" >> $GITHUB_OUTPUT
+          echo "MERGE_FAILED=$MERGE_FAILED" >> $GITHUB_OUTPUT
+
+          if [ "$MERGE_FAILED" -eq 0 ]; then
+            if [[ "$PR_URL" =~ /pull/([0-9]+) ]]; then
+              PR_NUMBER="${BASH_REMATCH[1]}"
+              gh pr merge --squash "$PR_NUMBER" --auto --subject "Merging to $GITHUB_BRANCH: $TITLE" --body "$BODY" || echo "Auto-merge failed"
+            fi
+          fi
+
+      - name: Comment back on original PR
+        if: steps.check_command.outputs.release_valid == 'true' && always()
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const prUrl = '${{ steps.cherry_pick.outputs.PR_URL }}';
+            const mergeFailed = '${{ steps.cherry_pick.outputs.MERGE_FAILED }}' === '1';
+            let body;
+
+            if ('${{ job.status }}' === 'success') {
+              if (mergeFailed) {
+                body = `⚠️ Cherry-pick completed with conflicts. A draft PR was created: ${prUrl}`;
+              } else if (prUrl) {
+                body = `✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): ${prUrl}`;
+              } else {
+                body = `ℹ️ Cherry-pick skipped: no changes needed in target branch.`;
+              }
+            } else {
+              body = '❌ Cherry-pick failed. Please check the workflow logs.';
+            }
+
+            github.rest.issues.createComment({
+              issue_number: ${{ steps.check_command.outputs.pr_number }},
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: body
+            });