dbt-adapters/.github/workflows/user-docs.yml at main · dbt-labs/dbt-adapters · 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
# **what?**
# Creates an issue in the docs repository when an issue is closed with the 'needs:docs' label.

# **why?**
# Ensures documentation updates are tracked and don't get forgotten when issues are closed.

# **when?**
# This workflow runs when an issue is labeled or closed, specifically when an issue is closed with the 'needs:docs' label.

name: "User docs"
run-name: "User docs - ${{ github.actor }} - #${{ github.event.issue.number }}: ${{ github.event.issue.title }}"

on:
    issues:
        types: [labeled, closed]

defaults:
    run:
        shell: bash

permissions:
    issues: write # comments on issues

# only run this once per issue
concurrency:
    group: ${{ github.workflow }}-${{ github.event.issue.number }}
    cancel-in-progress: true

jobs:
    open_issues:
        if: |
            github.event.issue.state == 'closed' &&
            github.event.issue.state_reason == 'completed' &&
            contains(github.event.issue.labels.*.name, 'needs:docs')
        uses: dbt-labs/actions/.github/workflows/open-issue-in-repo.yml@main
        with:
            issue_repository: "dbt-labs/docs.getdbt.com"
            issue_title: "Docs Changes Needed from dbt-adapters - Issue #${{ github.event.issue.number }}"
            issue_body: "At a minimum, update body to include a link to the page on docs.getdbt.com requiring updates and what part(s) of the page you would like to see updated."
        secrets: inherit