Skip to content

Creating workflow to open docs issue with need-docs label #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Creating workflow to open docs issue with need-docs label #497

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4b34508
Create docs-label-check.yaml
runleonarun Jul 31, 2025
80dfbc2
Update .github/workflows/docs-label-check.yaml
runleonarun Jul 31, 2025
f2b938c
Update docs-label-check.yaml
runleonarun Jul 31, 2025
06b696d
Update .github/workflows/docs-label-check.yaml
runleonarun Jul 31, 2025
72f9d78
Rename docs-label-check.yaml to docs-label.yaml
runleonarun Jul 31, 2025
1be9514
Apply suggestions from code review
runleonarun Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/docs-label.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# opens an issue in https://github.com/dbt-labs/docs-internal when a pr labeled with "needs-docs" is merged.

name: Open issues in docs-internal repo when a PR is merged
run-name: "Create an issue in docs-internal for PR #${{ github.event.pull_request.number }}"

on:
pull_request_target:
types: [labeled, closed]

permissions:
issues: write

jobs:
create-issue:
# Only run this job when a PR is merged and has the 'needs-docs' label
if: |
github.event.pull_request.merged == true &&
contains(github.event.pull_request.labels.*.name, 'needs-docs')
uses: dbt-labs/actions/.github/workflows/open-issue-in-repo.yml@main
with:
issue_repository: "dbt-labs/docs-internal"
issue_title: "Release Note: Changes from ${{ github.event.repository.name }} PR #${{ github.event.pull_request.number }}"
issue_body: |
Please review the merged PR and create appropriate release notes or updates in the documentation.
Feel free to ping the author (@${{ github.event.pull_request.user.login }}) directly if you have any questions!
Link to the merged PR: ${{ github.event.pull_request.html_url }}
secrets:
FISHTOWN_BOT_PAT: ${{ secrets.FA_ASSISTANT_CI_WORKFLOW_PAT_TOKEN }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this repo has access to this secret. It's not used in our public repos. Does FISHTOWN_BOT_PAT not have access to dbt-labs/docs-internal?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emmyoop I don't see access in the Settings > Secrets & Variables > Actions for the docs public or internal repos.

I wonder if we should open the issue in the docs public repo similar to the Core workflow and just copy how we do it over there (secrets: inherit)? Or would this repo still require access to that secret?