|
| 1 | +name: Deploy PR Preview |
| 2 | + |
| 3 | +on: |
| 4 | + pull_request: |
| 5 | + types: [opened, synchronize, reopened, closed] |
| 6 | + |
| 7 | +# Cancel previous runs when new commits are pushed to the PR |
| 8 | +concurrency: |
| 9 | + group: pr-preview-${{ github.event.pull_request.number }} |
| 10 | + cancel-in-progress: true |
| 11 | + |
| 12 | +jobs: |
| 13 | + deploy-preview: |
| 14 | + name: Deploy PR Preview |
| 15 | + runs-on: ubuntu-latest |
| 16 | + if: github.event.action != 'closed' |
| 17 | + permissions: |
| 18 | + pull-requests: write |
| 19 | + deployments: write |
| 20 | + contents: read |
| 21 | + |
| 22 | + steps: |
| 23 | + - name: Checkout PR code |
| 24 | + uses: actions/checkout@v6 |
| 25 | + with: |
| 26 | + ref: ${{ github.event.pull_request.head.sha }} |
| 27 | + |
| 28 | + - name: Setup Node.js |
| 29 | + uses: actions/setup-node@v6 |
| 30 | + with: |
| 31 | + node-version: '22' |
| 32 | + cache: 'npm' |
| 33 | + cache-dependency-path: 'package-lock.json' |
| 34 | + |
| 35 | + - name: Install dependencies |
| 36 | + run: | |
| 37 | + echo "Installing dependencies..." |
| 38 | + npm ci |
| 39 | +
|
| 40 | + - name: Build Docusaurus site |
| 41 | + env: |
| 42 | + DOCUSAURUS_BASE_URL: /pr-${{ github.event.pull_request.number }} |
| 43 | + run: | |
| 44 | + echo "Building site with base URL: $DOCUSAURUS_BASE_URL" |
| 45 | + npm run build |
| 46 | +
|
| 47 | + - name: Prepare deployment directory |
| 48 | + run: | |
| 49 | + PR_DIR="pr-${{ github.event.pull_request.number }}" |
| 50 | + echo "Creating directory: $PR_DIR" |
| 51 | + mkdir -p "$PR_DIR" |
| 52 | +
|
| 53 | + # Create config.yaml |
| 54 | + cat > "$PR_DIR/config.yaml" << 'EOF' |
| 55 | + static: |
| 56 | + files: 'build/**' |
| 57 | + urlPath: 'pr-${{ github.event.pull_request.number }}' |
| 58 | + extensions: ['html'] |
| 59 | + index: true |
| 60 | + EOF |
| 61 | +
|
| 62 | + # Copy build directory |
| 63 | + cp -r build "$PR_DIR/" |
| 64 | +
|
| 65 | + echo "Contents of $PR_DIR:" |
| 66 | + ls -la "$PR_DIR" |
| 67 | +
|
| 68 | + - name: Install HarperDB CLI |
| 69 | + run: | |
| 70 | + npm install harperdb |
| 71 | +
|
| 72 | + - name: Deploy to HarperDB |
| 73 | + env: |
| 74 | + HARPER_PREVIEW_TARGET: ${{ secrets.HARPER_PREVIEW_TARGET }} |
| 75 | + HARPER_PREVIEW_USERNAME: ${{ secrets.HARPER_PREVIEW_USERNAME }} |
| 76 | + HARPER_PREVIEW_PASSWORD: ${{ secrets.HARPER_PREVIEW_PASSWORD }} |
| 77 | + run: | |
| 78 | + cd "$PR_DIR" |
| 79 | + # Add your additional arguments here |
| 80 | + npx harper deploy \ |
| 81 | + target=$HARPER_PREVIEW_TARGET \ |
| 82 | + username=$HARPER_PREVIEW_USERNAME \ |
| 83 | + password=$HARPER_PREVIEW_PASSWORD \ |
| 84 | + project=pr-${{ github.event.pull_request.number }} \ |
| 85 | + restart=true \ |
| 86 | + replicated=true |
| 87 | +
|
| 88 | + - name: Create deployment |
| 89 | + env: |
| 90 | + HARPER_PREVIEW_TARGET: ${{ secrets.HARPER_PREVIEW_TARGET }} |
| 91 | + uses: actions/github-script@v8 |
| 92 | + with: |
| 93 | + script: | |
| 94 | + const prNumber = context.payload.pull_request.number; |
| 95 | + const target = process.env.HARPER_PREVIEW_TARGET; |
| 96 | + const deploymentUrl = `${target}/pr-${prNumber}`; |
| 97 | +
|
| 98 | + // Create deployment |
| 99 | + const deployment = await github.rest.repos.createDeployment({ |
| 100 | + owner: context.repo.owner, |
| 101 | + repo: context.repo.repo, |
| 102 | + ref: context.payload.pull_request.head.sha, |
| 103 | + environment: `pr-${prNumber}`, |
| 104 | + description: `Preview deployment for PR #${prNumber}`, |
| 105 | + auto_merge: false, |
| 106 | + required_contexts: [] |
| 107 | + }); |
| 108 | +
|
| 109 | + // Create deployment status |
| 110 | + await github.rest.repos.createDeploymentStatus({ |
| 111 | + owner: context.repo.owner, |
| 112 | + repo: context.repo.repo, |
| 113 | + deployment_id: deployment.data.id, |
| 114 | + state: 'success', |
| 115 | + environment_url: deploymentUrl, |
| 116 | + description: 'Preview deployment successful' |
| 117 | + }); |
| 118 | +
|
| 119 | + // Also add a comment to the PR |
| 120 | + await github.rest.issues.createComment({ |
| 121 | + owner: context.repo.owner, |
| 122 | + repo: context.repo.repo, |
| 123 | + issue_number: prNumber, |
| 124 | + body: `## 🚀 Preview Deployment\n\nYour preview deployment is ready!\n\n🔗 **Preview URL:** ${deploymentUrl}\n\nThis preview will update automatically when you push new commits.` |
| 125 | + }); |
| 126 | +
|
| 127 | + cleanup-preview: |
| 128 | + name: Cleanup PR Preview |
| 129 | + runs-on: ubuntu-latest |
| 130 | + if: github.event.action == 'closed' |
| 131 | + permissions: |
| 132 | + pull-requests: write |
| 133 | + deployments: write |
| 134 | + contents: read |
| 135 | + |
| 136 | + steps: |
| 137 | + - name: Checkout code |
| 138 | + uses: actions/checkout@v6 |
| 139 | + |
| 140 | + - name: Setup Node.js |
| 141 | + uses: actions/setup-node@v6 |
| 142 | + with: |
| 143 | + node-version: '22' |
| 144 | + cache: 'npm' |
| 145 | + cache-dependency-path: 'package-lock.json' |
| 146 | + |
| 147 | + - name: Install HarperDB CLI |
| 148 | + run: | |
| 149 | + npm install harperdb |
| 150 | +
|
| 151 | + - name: Remove preview deployment |
| 152 | + run: | |
| 153 | + # Add your cleanup command here (e.g., harper undeploy or similar) |
| 154 | + npx harper drop-component project=pr-${{ github.event.pull_request.number }} replicated=true restart=true |
| 155 | + echo "Cleaning up preview for PR #${{ github.event.pull_request.number }}" |
| 156 | +
|
| 157 | + - name: Update deployment status |
| 158 | + uses: actions/github-script@v7 |
| 159 | + with: |
| 160 | + script: | |
| 161 | + const prNumber = context.payload.pull_request.number; |
| 162 | +
|
| 163 | + // Mark deployment as inactive |
| 164 | + const deployments = await github.rest.repos.listDeployments({ |
| 165 | + owner: context.repo.owner, |
| 166 | + repo: context.repo.repo, |
| 167 | + environment: `pr-${prNumber}` |
| 168 | + }); |
| 169 | +
|
| 170 | + for (const deployment of deployments.data) { |
| 171 | + await github.rest.repos.createDeploymentStatus({ |
| 172 | + owner: context.repo.owner, |
| 173 | + repo: context.repo.repo, |
| 174 | + deployment_id: deployment.id, |
| 175 | + state: 'inactive', |
| 176 | + description: 'Preview deployment removed' |
| 177 | + }); |
| 178 | + } |
| 179 | +
|
| 180 | + // Add cleanup comment to PR |
| 181 | + await github.rest.issues.createComment({ |
| 182 | + owner: context.repo.owner, |
| 183 | + repo: context.repo.repo, |
| 184 | + issue_number: prNumber, |
| 185 | + body: `## 🧹 Preview Cleanup\n\nThe preview deployment for this PR has been removed.` |
| 186 | + }); |
0 commit comments