zulip/.github/workflows/api-docs-update-check.yml at main · Sauravkolte/zulip · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
name: API Documentation Update Check

on:
  push:
    branches: [main]
    paths:
      - "api_docs/**"
  workflow_dispatch:

permissions:
  contents: read

jobs:
  check-feature-level-updated:
    runs-on: ubuntu-slim

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.x"

      - 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

  notify-if-api-docs-changed:
    runs-on: ubuntu-slim
    needs: check-feature-level-updated

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.x"

      - name: Run tools/github-changes-contain-file
        run: ./tools/github-changes-contain-file api_docs/changelog.md

      - name: Run tools/notify-if-api-docs-changed
        id: run_check
        run: ./tools/notify-if-api-docs-changed >> $GITHUB_OUTPUT
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Report status to CZO
        if: ${{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: "api documentation"
          topic: ${{ steps.run_check.outputs.topic }}
          type: "stream"
          content: ${{ steps.run_check.outputs.content }}