mirror of
https://github.com/zulip/zulip.git
synced 2025-11-02 13:03:29 +00:00
f9d52189fc
In the past, some API documentation changes were merged with unresolved placeholders like "ZF-..." instead of actual feature level numbers. This commit introduces a GitHub Action that scans the API docs for any occurrence of "ZF-". If found, it will fail the CI check and block the commit from being merged into main. This ensures that all feature level references are properly updated before merging.
47 lines
1.3 KiB
YAML
47 lines
1.3 KiB
YAML
name: Check feature level updated
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- "api_docs/**"
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
check-feature-level-updated:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
with:
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "3.x"
|
|
|
|
- name: Add required permissions
|
|
run: chmod +x ./tools/check-feature-level-updated
|
|
|
|
- name: Run tools/check-feature-level-updated
|
|
id: run_check
|
|
run: ./tools/check-feature-level-updated >> $GITHUB_OUTPUT
|
|
|
|
- name: Report status to CZO
|
|
if: ${{ steps.run_check.outputs.fail == 'true' && github.repository == 'zulip/zulip'}}
|
|
uses: zulip/github-actions-zulip/send-message@v1
|
|
with:
|
|
api-key: ${{ secrets.ZULIP_BOT_KEY }}
|
|
email: "github-actions-bot@chat.zulip.org"
|
|
organization-url: "https://chat.zulip.org"
|
|
to: "automated testing"
|
|
topic: ${{ steps.run_check.outputs.topic }}
|
|
type: "stream"
|
|
content: ${{ steps.run_check.outputs.content }}
|
|
|
|
- name: Fail job if feature level not updated in API docs
|
|
if: ${{ steps.run_check.outputs.fail == 'true' }}
|
|
run: exit 1
|