helm/.github/workflows/chart-doc.yaml at a00ab73afa8abc1494216e40bbb438bf85bbbb06 · rstudio/helm · 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
name: Document Charts

on:
  pull_request:

jobs:
  document:
    runs-on: ubuntu-latest
    name: helm-docs
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Helm
        uses: azure/setup-helm@v4

      - name: install Just
        uses: extractions/setup-just@v2

      - name: Install Quarto
        uses: quarto-dev/quarto-actions/setup@v2
        with:
          version: pre-release

      - name: Render Quarto Project
        uses: quarto-dev/quarto-actions/render@v2
        env:
          HELM_DOCS_VERSION: 1.13.1

      # checks for uncommitted changes to any generated READMEs
      - name: Git status check
        run: |
          ./tools/dev/check-uncommitted-changes.sh || \
          (echo "run 'just docs' and commit the result." && exit 1)

      - name: Notify Slack of chart documentation failure on main
        if: github.ref == 'refs/heads/main' && failure()
        uses: slackapi/slack-github-action@v1.27.0
        with:
          payload-delimiter: "_"
          payload: |
            {
              "blocks": [
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": "Chart Documentation failed, please check the logs.  ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
                  }
                }
              ]
            }
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK

  rbac:
    runs-on: ubuntu-latest
    name: rbac
    needs: document
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Helm
        uses: azure/setup-helm@v4

      - name: Add rstudio helm repo
        run: helm repo add rstudio https://helm.rstudio.com

      - name: install Just
        uses: extractions/setup-just@v2

      - name: Compute and update dependent files
        run: |
          just rbac

      # checks for uncommitted changes to any generated RBAC docs
      - name: Git status check
        run: |
          ./tools/dev/check-uncommitted-changes.sh || \
          (echo "run 'just rbac' and commit the result." && exit 1)

      - name: Notify Slack of chart documentation (rbac) failure on main
        if: github.ref == 'refs/heads/main' && failure()
        uses: slackapi/slack-github-action@v1.27.0
        with:
          payload-delimiter: "_"
          payload: |
            {
              "blocks": [
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": "Chart Documentation (RBAC) failed, please check the logs.  ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
                  }
                }
              ]
            }
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK