Merge pull request #1221 from Andre601/master

Add dedicated comment action for failed validation
This commit is contained in:
Andre_601
2026-07-01 14:12:32 +02:00
committed by GitHub
2 changed files with 34 additions and 55 deletions
@@ -0,0 +1,34 @@
#
# A separate Workflow to comment on Pull requests
# for failed Wiki validation runs.
#
# This is to avoid code execution injected by
# extensions, plugins or hooks in MkDocs, that could
# abuse write permissions.
#
name: "Comment on failed Validation"
on:
workflow_run:
workflows:
- "Validate Wiki Build"
types:
- completed
permissions:
pull-requests: write
jobs:
comment:
if: github.event.workflow_run.conclusion == 'failure'
runs-on: ubuntu-latest
steps:
- name: Comment on Pull request
uses: peter-evans/create-or-update-comment@v5
with:
issue-number: ${{ github.event.workflow_run.pull_requests[0].number }}
body: |
## Build validation failed
Something went wrong while running a test-build with this Pull request's changes.
Please check the [Workflow Run Logs](${{ github.event.workflow_run.html_url }}) for any details.
@@ -1,55 +0,0 @@
#
# Validates Pull requests targeting the wiki branch
# to ensure that the site can be build successfully
# without broken links, navigation, etc.
#
name: "Validate Wiki Build"
on:
pull_request:
types:
- opened
- reopened
- synchronize
paths-ignore:
- "README.md"
branches:
- wiki
workflow_dispatch:
permissions:
contents: read
issues: write
env:
RUN_URL: "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_number }}"
jobs:
buildWiki:
runs-on: ubuntu-latest
steps:
- name: "Checkout Repository"
uses: actions/checkout@v6
with:
fetch-depth: 0
ref: "${{ github.event.pull_request.head.sha }}"
- name: "Setup Python 3.x"
uses: actions/setup-python@v6
with:
python-version: 3.x
- name: "Install dependencies"
run: "python -m pip install mkdocs-material"
- name: "Build Site"
run: "mkdocs build --strict"
- name: "Create Comment"
uses: peter-evans/create-or-update-comment@v5
if: ${{ failure() }}
with:
body: |-
## Wiki Build failure
Something went wrong while creating a test-build of the Wiki for this Pull request.
Please check the [Workflow Logs](${{ env.RUN_URL }}) for any errors.
issue-number: "${{ github.event.pull_request.number }}"
token: "${{ secrets.GITHUB_TOKEN }}"
edit-mode: replace