From 49f996d4eac00865050c3c39576071b2d190aa1d Mon Sep 17 00:00:00 2001 From: Sim-hu <93906619+Sim-hu@users.noreply.github.com> Date: Wed, 25 Mar 2026 03:36:07 +0900 Subject: [PATCH] Add CI check for docs on feature PRs (#6315) Co-authored-by: 6543 <6543@obermui.de> --- .woodpecker/check-feature-docs.sh | 14 ++++++++++++++ .woodpecker/static.yaml | 9 +++++++++ 2 files changed, 23 insertions(+) create mode 100755 .woodpecker/check-feature-docs.sh diff --git a/.woodpecker/check-feature-docs.sh b/.woodpecker/check-feature-docs.sh new file mode 100755 index 0000000000..9fa78cabe2 --- /dev/null +++ b/.woodpecker/check-feature-docs.sh @@ -0,0 +1,14 @@ +#!/bin/sh +DOCS_CHANGED=$(echo "$CI_PIPELINE_FILES" | jq -r '.[]' | grep -c '^docs/docs/' || true) +if [ "$DOCS_CHANGED" -gt 0 ]; then + echo "✅ OK: docs/docs/ has changes" + exit 0 +fi +NON_CLI=$(echo "$CI_PIPELINE_FILES" | jq -r '.[]' | grep -v '^cli/' | grep -v '^cmd/cli/' | grep -v '^docs/' || true) +if [ -z "$NON_CLI" ]; then + echo "✅ OK: CLI-only feature, docs are auto-generated" + exit 0 +fi +echo "🚨 ERROR: PR has 'feature' label but no changes in docs/docs/" +echo "Please add documentation for the new feature." +exit 1 diff --git a/.woodpecker/static.yaml b/.woodpecker/static.yaml index 92b29947d3..a89f266695 100644 --- a/.woodpecker/static.yaml +++ b/.woodpecker/static.yaml @@ -25,6 +25,15 @@ steps: settings: version: 3.6.2 + - name: check-feature-docs + image: docker.io/alpine:3.23 + depends_on: [] + commands: + - apk add --no-cache -q jq && ./.woodpecker/check-feature-docs.sh + when: + - event: pull_request + evaluate: 'CI_COMMIT_PULL_REQUEST_LABELS contains "feature"' + - name: agentscan image: docker.io/woodpeckerci/plugin-agentscan:latest pull: true