From f6471058e77ee8d1e1b96825f2b17609d50430f1 Mon Sep 17 00:00:00 2001 From: Emily Rockman Date: Fri, 22 Mar 2024 12:22:56 -0500 Subject: [PATCH 1/2] update triggers to use issues --- .github/workflows/docs-issue.yml | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs-issue.yml b/.github/workflows/docs-issue.yml index 00a098df827..f5b04e6d1fa 100644 --- a/.github/workflows/docs-issue.yml +++ b/.github/workflows/docs-issue.yml @@ -5,15 +5,14 @@ # To reduce barriers for keeping docs up to date # **when?** -# When a PR is labeled `user docs` and is merged. Runs on pull_request_target to run off the workflow already merged, -# not the workflow that existed on the PR branch. This allows old PRs to get comments. +# When an issue is labeled `user docs` and is closed as completed. Can be labeled before or after the issue is closed. name: Open issues in docs.getdbt.com repo when a PR is labeled run-name: "Open an issue in docs.getdbt.com for PR #${{ github.event.pull_request.number }}" on: - pull_request_target: + issues: types: [labeled, closed] defaults: @@ -21,20 +20,19 @@ defaults: shell: bash permissions: - issues: write # opens new issues - pull-requests: write # comments on PRs - + issues: write # comments on issues jobs: open_issues: - # we only want to run this when the PR has been merged or the label in the labeled event is `user docs`. Otherwise it runs the + # we only want to run this when the is closed as completed and the label `user docs` has been assigned. + # If this logic does nto exist in this workflow, it runs the # risk of duplicaton of issues being created due to merge and label both triggering this workflow to run and neither having # generating the comment before the other runs. This lives here instead of the shared workflow because this is where we # decide if it should run or not. if: | - (github.event.pull_request.merged == true) && - ((github.event.action == 'closed' && contains( github.event.pull_request.labels.*.name, 'user docs')) || - (github.event.action == 'labeled' && github.event.label.name == 'user docs')) + (github.event.issue.state == 'closed' && + github.event.issue.state_reason == 'completed' && + contains( github.event.pull_request.labels.*.name, 'user docs')) uses: dbt-labs/actions/.github/workflows/open-issue-in-repo.yml@main with: issue_repository: "dbt-labs/docs.getdbt.com" From f6b3e356d47f91c5ca925ccd93ffa594e28558ed Mon Sep 17 00:00:00 2001 From: Emily Rockman Date: Fri, 22 Mar 2024 13:21:00 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Quigley Malcolm --- .github/workflows/docs-issue.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-issue.yml b/.github/workflows/docs-issue.yml index f5b04e6d1fa..da1659f957c 100644 --- a/.github/workflows/docs-issue.yml +++ b/.github/workflows/docs-issue.yml @@ -24,8 +24,8 @@ permissions: jobs: open_issues: - # we only want to run this when the is closed as completed and the label `user docs` has been assigned. - # If this logic does nto exist in this workflow, it runs the + # we only want to run this when the issue is closed as completed and the label `user docs` has been assigned. + # If this logic does not exist in this workflow, it runs the # risk of duplicaton of issues being created due to merge and label both triggering this workflow to run and neither having # generating the comment before the other runs. This lives here instead of the shared workflow because this is where we # decide if it should run or not.