codereview: use composite action, actions/download-artifact, and add comments

Author: chouetz

.github/actions/assign-team-label/action.yml

@@ -0,0 +1,25 @@
+---
+name: Install dda
+description: Installs the defined version of dda
+inputs:
+  pr-number:
+    description: The PR number
+    required: true
+  github-token:
+    description: Github token to write label in the PR
+    required: true
+
+runs:
+  using: composite
+  steps:
+  - name: Assign team label
+    run: dda inv -- -e github.assign-team-label --pr-id="${{ inputs.pr-number }}"
+    env:
+      GITHUB_TOKEN: ${{ inputs.github-token }}
+  - name: Save PR number for workflow_run
+    run: echo "${{ inputs.pr-number }}" > pr_number.txt
+  - name: Upload PR number artifact
+    uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+    with:
+      name: pr_number
+      path: pr_number.txt

.github/workflows/add-label-community-pr.yml

@@ -4,7 +4,7 @@ name: Add labels to community PRs
 on:
   # run in the context of the base branch, so that it still works in PR from forks
   pull_request_target:
-    types: [opened, synchronize]
+    types: [opened, synchronize, reopened]
 
 permissions: {}
 
@@ -38,13 +38,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SLACK_DATADOG_AGENT_BOT_TOKEN: ${{ secrets.SLACK_DATADOG_AGENT_BOT_TOKEN }}
       - name: Assign team label
-        run: dda inv -- -e github.assign-team-label --pr-id="${{ github.event.pull_request.number }}"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Save PR number for workflow_run
-        run: echo "${{ github.event.pull_request.number }}" > pr_number.txt
-      - name: Upload PR number artifact
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        uses: ./.github/actions/assign-team-label
         with:
-          name: pr_number
-          path: pr_number.txt
+          pr-number: ${{ github.event.pull_request.number }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/add-label-pr.yml

@@ -31,10 +31,6 @@ jobs:
         uses: ./.github/actions/install-dda
         with:
           features: legacy-tasks
-      - name: Auto assign team label
-        run: dda inv -- -e github.assign-team-label --pr-id="${{ github.event.pull_request.number }}"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Add the internal label
         uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0
         with:
@@ -46,10 +42,8 @@ jobs:
               issue_number: ${{ github.event.pull_request.number }},
               labels: ['internal']
             });
-      - name: Save PR number for workflow_run
-        run: echo "${{ github.event.pull_request.number }}" > pr_number.txt
-      - name: Upload PR number artifact
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+      - name: Assign team label
+        uses: ./.github/actions/assign-team-label
         with:
-          name: pr_number
-          path: pr_number.txt
+          pr-number: ${{ github.event.pull_request.number }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/label-analysis.yml

@@ -8,6 +8,8 @@ on:
       - main
       - "[0-9]+.[0-9]+.x"
   workflow_run:
+    # We need to run the label analysis as workflow_run because the label addition will not trigger it.
+    # See documentation https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow
     workflows: ["Add labels to PR", "Add labels to community PRs"]
     types: [completed]
 
@@ -27,32 +29,13 @@ jobs:
       HEAD_REF: ${{ steps.context.outputs.head_ref }}
       IS_FORK: ${{ steps.context.outputs.is_fork }}
     steps:
-      - name: Get PR number from artifact (workflow_run)
+      - name: Download PR number artifact
         if: github.event_name == 'workflow_run'
-        uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
         with:
-          script: |
-            const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              run_id: ${{ github.event.workflow_run.id }},
-            });
-            const matchArtifact = artifacts.data.artifacts.find(artifact => artifact.name === 'pr_number');
-            if (!matchArtifact) {
-              core.setFailed('No pr_number artifact found');
-              return;
-            }
-            const download = await github.rest.actions.downloadArtifact({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              artifact_id: matchArtifact.id,
-              archive_format: 'zip',
-            });
-            const fs = require('fs');
-            fs.writeFileSync('${{ github.workspace }}/pr_number.zip', Buffer.from(download.data));
-      - name: Extract PR number artifact
-        if: github.event_name == 'workflow_run'
-        run: unzip pr_number.zip
+          name: pr_number
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
       - name: Get PR context
         id: context
         env:

tasks/github_tasks.py

@@ -155,6 +155,12 @@ def get_token_from_app(_, app_id_env='GITHUB_APP_ID', pkey_env='GITHUB_KEY_B64')
 
 
 def _get_teams(changed_files, owners_file='.github/CODEOWNERS', best_teams_only=True) -> list[str]:
+    """Returns a list of teams that are responsible for changed files
+
+    :param changed_files: list of changed files
+    :param owners_file: path to the CODEOWNERS file
+    :param best_teams_only: if True, returns only the teams with the most changed files
+    """
     codeowners = read_owners(owners_file)
 
     team_counter = Counter()