Stop posting docs preview PR comments; link preview from status check (#37491)

Docs preview cleanup and build workflows no longer post PR comments.
The build workflows now surface the preview URL via the commit status's
target_url instead, so the status check links directly to the preview.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Eva Sarafianou
2026-07-14 14:29:28 +03:00
committed by GitHub
co-authored by Cursor
parent 72250e687e
commit 2d8a5f94ba
4 changed files with 52 additions and 35 deletions
@@ -9,15 +9,11 @@ on:
permissions:
contents: read
pull-requests: write
jobs:
cleanup:
name: Delete preview from S3
runs-on: ubuntu-latest
# Fork PRs don't get secrets on plain pull_request events, so this would
# just fail for them -- a separate scheduled sweep handles fork preview
# cleanup instead of switching this to pull_request_target.
if: github.event.pull_request.head.repo.full_name == github.repository
steps:
- name: Configure AWS credentials
@@ -33,11 +29,3 @@ jobs:
BUCKET_NAME: ${{ vars.DOCS_PREVIEW_BUCKET_NAME }}
run: |
aws s3 rm "s3://${BUCKET_NAME}/mattermost/pr-${PR_NUMBER}/" --recursive
- name: Comment on closed PR
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.number }}
run: |
gh pr comment "$PR_NUMBER" --repo "${{ github.repository }}" \
--body "Docs preview for PR #${PR_NUMBER} has been removed from S3."
+1 -2
View File
@@ -19,7 +19,6 @@ on:
permissions:
contents: read
statuses: write
pull-requests: write
jobs:
update-initial-status:
@@ -45,7 +44,6 @@ jobs:
- update-initial-status
with:
PR_NUMBER: ${{ inputs.PR_NUMBER }}
TRIGGERING_ACTOR: ${{ inputs.TRIGGERING_ACTOR }}
COMMIT_SHA: ${{ inputs.COMMIT_SHA }}
update-failure-status:
@@ -79,3 +77,4 @@ jobs:
context: "docs-preview-fork / preview"
description: "Docs preview build for ${{ inputs.COMMIT_SHA }} succeeded"
status: success
target_url: "http://${{ vars.DOCS_PREVIEW_BUCKET_NAME }}.s3-website-us-east-1.amazonaws.com/mattermost/pr-${{ inputs.PR_NUMBER }}/"
@@ -6,9 +6,6 @@ on:
PR_NUMBER:
type: string
required: true
TRIGGERING_ACTOR:
type: string
required: true
COMMIT_SHA:
type: string
required: true
@@ -26,7 +23,6 @@ concurrency:
permissions:
contents: read
pull-requests: write
jobs:
preview:
@@ -93,18 +89,3 @@ jobs:
"s3://${BUCKET_NAME}/mattermost/pr-${PR_NUMBER}/" \
--delete \
--no-progress
- name: Post preview URL comment
# Plain gh CLI instead of a third-party action -- posts a new comment
# every run (same behavior peter-evans/create-or-update-comment had
# here, since it wasn't given a comment-id/body-includes matcher).
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ inputs.PR_NUMBER }}
TRIGGERING_ACTOR: ${{ inputs.TRIGGERING_ACTOR }}
COMMIT_SHA: ${{ inputs.COMMIT_SHA }}
BUCKET_NAME: ${{ vars.DOCS_PREVIEW_BUCKET_NAME }}
run: |
BODY=$(printf 'Newest code from %s and commit %s has docs preview environment ready:\n\n**[Open preview environment](http://%s.s3-website-us-east-1.amazonaws.com/mattermost/pr-%s/)**' \
"$TRIGGERING_ACTOR" "$COMMIT_SHA" "$BUCKET_NAME" "$PR_NUMBER")
gh pr comment "$PR_NUMBER" --repo "${{ github.repository }}" --body "$BODY"
+51 -2
View File
@@ -9,16 +9,65 @@ on:
permissions:
contents: read
pull-requests: write
statuses: write
jobs:
update-initial-status:
runs-on: ubuntu-latest
if: github.event.pull_request.head.repo.full_name == github.repository
steps:
- name: Set pending commit status
uses: mattermost/actions/delivery/update-commit-status@fec7b836001c9380d4bfaf28d443945c103a098c
env:
GITHUB_TOKEN: ${{ github.token }}
with:
repository_full_name: ${{ github.repository }}
commit_sha: ${{ github.event.pull_request.head.sha }}
context: "docs-preview / preview"
description: "Docs preview build for ${{ github.event.pull_request.head.sha }} is running"
status: pending
deploy:
uses: ./.github/workflows/docs-preview-template.yml
if: github.event.pull_request.head.repo.full_name == github.repository
needs:
- update-initial-status
secrets:
AWS_DOCS_PR_PREVIEW_KEY_ID: ${{ secrets.AWS_DOCS_PR_PREVIEW_KEY_ID }}
AWS_DOCS_PR_PREVIEW_SECRET_ACCESS_KEY: ${{ secrets.AWS_DOCS_PR_PREVIEW_SECRET_ACCESS_KEY }}
with:
PR_NUMBER: ${{ github.event.number }}
TRIGGERING_ACTOR: ${{ github.event.pull_request.user.login }}
COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
update-failure-status:
runs-on: ubuntu-latest
if: failure() || cancelled()
needs:
- deploy
steps:
- uses: mattermost/actions/delivery/update-commit-status@fec7b836001c9380d4bfaf28d443945c103a098c
env:
GITHUB_TOKEN: ${{ github.token }}
with:
repository_full_name: ${{ github.repository }}
commit_sha: ${{ github.event.pull_request.head.sha }}
context: "docs-preview / preview"
description: "Docs preview build for ${{ github.event.pull_request.head.sha }} failed"
status: failure
update-success-status:
runs-on: ubuntu-latest
if: success()
needs:
- deploy
steps:
- uses: mattermost/actions/delivery/update-commit-status@fec7b836001c9380d4bfaf28d443945c103a098c
env:
GITHUB_TOKEN: ${{ github.token }}
with:
repository_full_name: ${{ github.repository }}
commit_sha: ${{ github.event.pull_request.head.sha }}
context: "docs-preview / preview"
description: "Docs preview build for ${{ github.event.pull_request.head.sha }} succeeded"
status: success
target_url: "http://${{ vars.DOCS_PREVIEW_BUCKET_NAME }}.s3-website-us-east-1.amazonaws.com/mattermost/pr-${{ github.event.number }}/"