Merge branch 'master' into dougqh/advice-annotation-checking

Author: dougqh

.circleci/render_config.py

@@ -28,7 +28,7 @@
 }
 # Version to use for all the base Docker images, see
 # https://github.com/DataDog/dd-trace-java-docker-build/pkgs/container/dd-trace-java-docker-build
-DOCKER_IMAGE_VERSION="v24.08"
+DOCKER_IMAGE_VERSION="v24.10"
 
 # Get labels from pull requests to override some defaults for jobs to run.
 # `run-tests: all` will run all tests.

.github/workflows/README.md

@@ -20,6 +20,14 @@ _Action:_ Append the new release to the Cloud Foundry repository.
 
 _Recovery:_ Manually edit and push the `index.yml` file from [the cloudfoundry branch](https://github.com/DataDog/dd-trace-java/tree/cloudfoundry).
 
+### check-pull-requests [🔗](check-pull-requests.yaml)
+
+_Trigger:_ When creating or updating a pull request.
+
+_Action:_ Check the pull request complies with [the contribution guidelines](https://github.com/DataDog/dd-trace-java/blob/master/CONTRIBUTING.md).
+
+_Recovery:_ Manually verify the guideline compliance.
+
 ### create-next-milestone [🔗](create-next-milestone.yaml)
 
 _Trigger:_ When closing a milestone.

.github/workflows/analyze-changes.yaml

@@ -140,6 +140,9 @@ jobs:
           output: 'trivy-results.sarif'
           severity: 'CRITICAL,HIGH'
           limit-severities-for-sarif: true
+        env:
+          TRIVY_DB_REPOSITORY: ghcr.io/aquasecurity/trivy-db,public.ecr.aws/aquasecurity/trivy-db
+          TRIVY_JAVA_DB_REPOSITORY: ghcr.io/aquasecurity/trivy-java-db,public.ecr.aws/aquasecurity/trivy-java-db
 
       - name: Upload Trivy scan results to GitHub Security tab
         uses: github/codeql-action/upload-sarif@4dd16135b69a43b6c8efb853346f8437d92d3c93 # v3.26.6

.github/workflows/check-pull-requests.yaml

@@ -0,0 +1,75 @@
+name: Check pull requests
+on:
+  pull_request:
+    types: [opened, edited, labeled, unlabeled]
+    branches:
+    - master
+    - release/v*
+jobs:
+  check_pull_requests:
+    name: Check pull requests
+    permissions:
+      issues: write # Required to create a comment on the pull request
+      pull-requests: write # Required to create a comment on the pull request
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check pull requests
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # 7.0.1
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            // Skip draft pull requests
+            if (context.payload.pull_request.draft) {
+              return
+            }
+            // Check at least one type and (component or instrumentation) label is set
+            const labels = context.payload.pull_request.labels.map(label => label.name)
+            const ignoreReleaseNotes = labels.filter(label => label == 'tag: no release notes').length > 0
+            const hasTypeLabel = labels.filter(label => label.startsWith('type:')).length > 0
+            const hasComponentLabel = labels.filter(label => label.startsWith('comp:')).length > 0
+            const hasInstrumentationLabel = labels.filter(label => label.startsWith('instr:')).length > 0
+            const labelsCheckFailed = !ignoreReleaseNotes && (!hasTypeLabel || (!hasComponentLabel && !hasInstrumentationLabel));
+            if (labelsCheckFailed) {
+              core.setFailed('Please add at least one type, and one component or instrumentation label to the pull request.')
+            }
+            // Check title does not contain tag
+            const title = context.payload.pull_request.title
+            const titleCheckFailed = title.match(/\[.*\]/)
+            if (titleCheckFailed) {
+              core.setFailed('Please remove the tag from the pull request title.')
+            }
+            // Add comment to the pull request
+            if (labelsCheckFailed || titleCheckFailed) {
+              // Define comment body
+              const commentMarker = '<!-- dd-trace-java-check-pull-requests-workflow -->'
+              const commentBody = 'Hi! 👋 Thanks for your pull request! 🎉\n\n' +
+                  'To help us review it, please make sure to:\n\n' +
+                  (labelsCheckFailed ? '* Add at least one type, and one component or instrumentation label to the pull request\n' : '') +
+                  (titleCheckFailed ? '* Remove the tag from the pull request title\n' : '') +
+                  '\nIf you need help, please check our [contributing guidelines](https://github.com/DataDog/dd-trace-java/blob/master/CONTRIBUTING.md).' +
+                  '\n\n' + commentMarker
+              // Look for previous comment
+              const comments = await github.rest.issues.listComments({
+                issue_number: context.payload.pull_request.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo
+              })
+              const previousComment = comments.data.find(comment => comment.body.includes(commentMarker))
+              if (previousComment) {
+                // Update previous comment
+                await github.rest.issues.updateComment({
+                  comment_id: previousComment.id,
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  body: commentBody
+                })
+              } else {
+                // Create new comment
+                await github.rest.issues.createComment({
+                  issue_number: context.payload.pull_request.number,
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  body: commentBody
+                })
+              }
+            }

.github/workflows/tests/check-pull-requests/payload-pull-request-draft.json

@@ -0,0 +1,8 @@
+{
+    "pull_request": {
+        "number": 7884,
+        "draft": true,
+        "labels": [],
+        "title": "Adding some new features"
+    }
+}

.github/workflows/tests/check-pull-requests/payload-pull-request-missing-label.json

@@ -0,0 +1,12 @@
+{
+    "pull_request": {
+        "number": 7884,
+        "draft": false,
+        "labels": [
+            {
+                "name": "comp: api"
+            }
+        ],
+        "title": "Adding some new features"
+    }
+}

.github/workflows/tests/check-pull-requests/payload-pull-request-no-release-notes.json

@@ -0,0 +1,12 @@
+{
+    "pull_request": {
+        "number": 7884,
+        "draft": false,
+        "labels": [
+            {
+                "name": "tag: no release notes"
+            }
+        ],
+        "title": "Adding some new features"
+    }
+}

.github/workflows/tests/check-pull-requests/payload-pull-request-title-tag.json

@@ -0,0 +1,15 @@
+{
+    "pull_request": {
+        "number": 7884,
+        "draft": false,
+        "labels": [
+            {
+                "name": "comp: api"
+            },
+            {
+                "name": "type: enhancement"
+            }
+        ],
+        "title": "[API] Adding some new features"
+    }
+}

.github/workflows/tests/check-pull-requests/payload-pull-request.json

@@ -0,0 +1,15 @@
+{
+    "pull_request": {
+        "number": 7884,
+        "draft": false,
+        "labels": [
+            {
+                "name": "comp: api"
+            },
+            {
+                "name": "type: enhancement"
+            }
+        ],
+        "title": "Adding some new features"
+    }
+}

.github/workflows/tests/check-pull-requests/test-pull-request.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+source "$(dirname "$0")/../env.sh"
+testworkflow pull_request && \
+testworkflow pull_request draft && \
+testworkflow pull_request no-release-notes && \
+! testworkflow pull_request missing-label && \
+! testworkflow pull_request title-tag