docs/.github/workflows/validate-branch-existence.yml at main · cockroachdb/docs · 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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
name: Validate Branch Existence

# EDUENG-614
# Verifies that every crdb_branch_name in versions.csv exists as a branch in
# cockroachdb/generated-diagrams, and flags entries where a proper release-X.Y
# branch has been created but versions.csv still points to an older one.

on:
  pull_request:
    types: [opened, synchronize, reopened]
    paths:
      - 'src/current/_data/versions.csv'
  schedule:
    # Daily at 07:00 UTC.
    - cron: '0 7 * * *'
  workflow_dispatch:

jobs:
  validate-branch-existence:
    name: Check crdb_branch_name entries against generated-diagrams
    runs-on: ubuntu-latest

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

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

      - name: Run branch existence check
        id: validate
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_ACTIONS: 'true'
        run: python .github/scripts/validate_branch_existence.py
        continue-on-error: true

      - name: Post PR comment
        if: github.event_name == 'pull_request'
        uses: actions/github-script@v7
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            const fs = require('fs');
            const marker = '<!-- branch-existence-check -->';

            let body = marker + '\n';
            try {
              body += fs.readFileSync('pr-comment.md', 'utf8');
            } catch {
              body += '### Branch Existence Check\n\nCheck ran but could not generate a detailed report.';
            }

            const { data: comments } = await github.rest.issues.listComments({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
            });

            const existing = comments.find(
              c => c.user.type === 'Bot' && c.body.includes(marker)
            );

            if (existing) {
              await github.rest.issues.updateComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                comment_id: existing.id,
                body,
              });
            } else {
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.issue.number,
                body,
              });
            }

      - name: Fail on PR issues
        if: github.event_name == 'pull_request' && steps.validate.outcome == 'failure'
        run: |
          echo "Branch existence check failed. See the PR comment for details."
          exit 1

      - name: Open or update tracking issue (scheduled failure)
        if: github.event_name != 'pull_request' && steps.validate.outcome == 'failure'
        uses: actions/github-script@v7
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            const fs = require('fs');
            const runUrl = `${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`;

            let detail = '';
            try {
              detail = fs.readFileSync('pr-comment.md', 'utf8');
            } catch {
              detail = `Check failed. See [workflow run](${runUrl}) for details.`;
            }

            const label = 'sql-diagram-validation';
            const { data: issues } = await github.rest.issues.listForRepo({
              owner: context.repo.owner,
              repo: context.repo.repo,
              state: 'open',
              labels: label,
            });

            if (issues.length === 0) {
              await github.rest.issues.create({
                owner: context.repo.owner,
                repo: context.repo.repo,
                title: 'Branch existence check failure (automated)',
                body: [
                  'Opened automatically by the nightly branch existence workflow.',
                  '',
                  detail,
                  '',
                  `[Workflow run](${runUrl})`,
                ].join('\n'),
                labels: [label],
              });
            } else {
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: issues[0].number,
                body: `**Nightly update** — [run ${{ github.run_id }}](${runUrl}):\n\n${detail}`,
              });
            }