vy commented on code in PR #419: URL: https://github.com/apache/logging-parent/pull/419#discussion_r2309248142
########## .github/workflows/analyze-dependabot-reusable.yaml: ########## @@ -0,0 +1,55 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Analyze PR + +on: + workflow_call: + +jobs: + + analyze-pull-request: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + id: dependabot + uses: ppkarwasz/fetch-metadata@feat/multi-versions Review Comment: I presume this will be replaced once dependabot/fetch-metadata#632 is merged. ########## .github/workflows/analyze-dependabot-reusable.yaml: ########## @@ -0,0 +1,55 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Analyze PR + +on: + workflow_call: + +jobs: + + analyze-pull-request: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + id: dependabot + uses: ppkarwasz/fetch-metadata@feat/multi-versions + with: + github-token: ${{ github.token }} + + # + # Stores the data required by the process-dependabot-reusable workflow as JSON files. + # + - name: Create artifacts + shell: bash + env: + PULL_REQUEST: ${{ toJSON(github.event.pull_request) }} + UPDATED_DEPENDENCIES: ${{ steps.dependabot.outputs.updated-dependencies-json }} + run: | + mkdir -p dependabot-metadata Review Comment: Is `-p` necessary here, since we only provide a single folder name? ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' Review Comment: Do we expect an occasion where these defaults will be overriden? If not, please consider inlining them. I prefer code that is 8 lines shorter compared to a functionality that we don't use. ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" + echo "PR_ID=$(jq -r '.number' < "$pull_request")" >> $GITHUB_ENV + echo "PR_URL=$(jq -r '.html_url' < "$pull_request")" >> $GITHUB_ENV + echo "PR_HEAD_REF=$(jq -r '.head.ref' < "$pull_request")" >> $GITHUB_ENV + + - name: Check out repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + with: + ref: ${{ env.PR_HEAD_REF }} + token: ${{ secrets.RECURSIVE_TOKEN }} + + - name: Install `xmlstarlet` + shell: bash + run: sudo apt-get update && sudo apt-get install -y xmlstarlet + + - name: Find the release version major + shell: bash + run: | + revision=$( + xmlstarlet sel \ + -N m=http://maven.apache.org/POM/4.0.0 \ + --template --value-of /m:project/m:properties/m:revision \ + pom.xml + ) + if [[ ! $revision =~ ^[0-9]+\.[0-9]+\.[0-9]+(-SNAPSHOT)?$ ]]; then + echo "Invalid version format: $revision" + exit 1 + fi + parts=(${revision//./ }) + echo "RELEASE_VERSION_MAJOR=${parts[0]}" >> $GITHUB_ENV Review Comment: We can alternatively use the parameter expansion: ```suggestion revisionMajor=${revision%%.*} echo "RELEASE_VERSION_MAJOR=$revisionMajor" >> $GITHUB_ENV ``` ########## src/site/antora/modules/ROOT/examples/process-dependabot.yaml: ########## @@ -0,0 +1,52 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: "Dependabot Process PR" + +on: + workflow_run: + workflows: + - "Dependabot Analyze PR" + types: + - completed + +permissions: { } + +jobs: + +# tag::process-dependabot[] + process-dependabot: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.event.workflow_run.conclusion == 'success' && github.actor == 'dependabot[bot]' }} Review Comment: Again, I'd keep the repository name validation. ########## .github/workflows/analyze-dependabot-reusable.yaml: ########## @@ -0,0 +1,55 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Analyze PR + +on: + workflow_call: Review Comment: ```suggestion workflow_call: { } ``` ########## .github/workflows/analyze-dependabot-reusable.yaml: ########## @@ -0,0 +1,55 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Analyze PR + +on: + workflow_call: + +jobs: + + analyze-pull-request: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + id: dependabot + uses: ppkarwasz/fetch-metadata@feat/multi-versions + with: + github-token: ${{ github.token }} + + # + # Stores the data required by the process-dependabot-reusable workflow as JSON files. + # Review Comment: ```suggestion # Creates the data required by the `process-dependabot-reusable` workflow as JSON files. ``` ########## .github/workflows/analyze-dependabot-reusable.yaml: ########## @@ -0,0 +1,55 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Analyze PR + +on: + workflow_call: + +jobs: + + analyze-pull-request: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + id: dependabot + uses: ppkarwasz/fetch-metadata@feat/multi-versions + with: + github-token: ${{ github.token }} + + # + # Stores the data required by the process-dependabot-reusable workflow as JSON files. + # + - name: Create artifacts + shell: bash + env: + PULL_REQUEST: ${{ toJSON(github.event.pull_request) }} + UPDATED_DEPENDENCIES: ${{ steps.dependabot.outputs.updated-dependencies-json }} + run: | + mkdir -p dependabot-metadata + echo "$PULL_REQUEST" > dependabot-metadata/pull_request.json + echo "$UPDATED_DEPENDENCIES" > dependabot-metadata/updated_dependencies.json Review Comment: This is the meat of this entire reusable workflow, 2 LoC, the rest is just ceremony. I think this should consider integrating this into `process-d-r`, and removing `analyze-d-r`. IIRC, you introduce this split for `analyze-d-r` needs less privileges compared to `process-d-r`. But the former is useless without the latter, hence, the split just inflates 2 LoC to 55 LoC, not to mention the inflation at call sites invoking these reusables. ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" + echo "PR_ID=$(jq -r '.number' < "$pull_request")" >> $GITHUB_ENV + echo "PR_URL=$(jq -r '.html_url' < "$pull_request")" >> $GITHUB_ENV + echo "PR_HEAD_REF=$(jq -r '.head.ref' < "$pull_request")" >> $GITHUB_ENV + + - name: Check out repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + with: + ref: ${{ env.PR_HEAD_REF }} + token: ${{ secrets.RECURSIVE_TOKEN }} + + - name: Install `xmlstarlet` + shell: bash + run: sudo apt-get update && sudo apt-get install -y xmlstarlet + + - name: Find the release version major + shell: bash + run: | + revision=$( + xmlstarlet sel \ + -N m=http://maven.apache.org/POM/4.0.0 \ + --template --value-of /m:project/m:properties/m:revision \ + pom.xml + ) + if [[ ! $revision =~ ^[0-9]+\.[0-9]+\.[0-9]+(-SNAPSHOT)?$ ]]; then + echo "Invalid version format: $revision" + exit 1 + fi + parts=(${revision//./ }) + echo "RELEASE_VERSION_MAJOR=${parts[0]}" >> $GITHUB_ENV + + - name: Create changelog entries + shell: bash + run: | + PULL_REQUEST="$RUNNER_TEMP/dependabot-metadata/pull_request.json" + UPDATED_DEPENDENCIES="$RUNNER_TEMP/dependabot-metadata/updated_dependencies.json" + # Generates the content of a changelog entry + function generate_changelog_entry() { + local dependency="$1" + local issue_id=$(xmlstarlet esc "$PR_ID") + local issue_link=$(xmlstarlet esc "$PR_URL") + local dependency_name=$(echo "$dependency" | jq -r '.dependencyName' | xmlstarlet esc) + local new_version=$(echo "$dependency" | jq -r '.newVersion' | xmlstarlet esc) + cat << CHANGELOG_ENTRY + <?xml version="1.0" encoding="UTF-8"?> + <!-- SPDX-License-Identifier: Apache-2.0 --> Review Comment: AFAIK, Logging Services speak CDX, not SPDX. I think we should discuss this with the rest of the crew and introduce it in a mass roll out instead of piggybacking. ```suggestion <!-- SPDX-License-Identifier: Apache-2.0 --> ``` ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" + echo "PR_ID=$(jq -r '.number' < "$pull_request")" >> $GITHUB_ENV + echo "PR_URL=$(jq -r '.html_url' < "$pull_request")" >> $GITHUB_ENV + echo "PR_HEAD_REF=$(jq -r '.head.ref' < "$pull_request")" >> $GITHUB_ENV Review Comment: Do we have a spec. somewhere on the JSON schema of the dependabot PR payload? If yes, sharing it here in a comment would be very useful for the next maintainer troubleshooting an issue here. ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" Review Comment: All of this can be avoided if 2 LoC moved from `analyze-d-r` to here. ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" + echo "PR_ID=$(jq -r '.number' < "$pull_request")" >> $GITHUB_ENV + echo "PR_URL=$(jq -r '.html_url' < "$pull_request")" >> $GITHUB_ENV + echo "PR_HEAD_REF=$(jq -r '.head.ref' < "$pull_request")" >> $GITHUB_ENV + + - name: Check out repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + with: + ref: ${{ env.PR_HEAD_REF }} + token: ${{ secrets.RECURSIVE_TOKEN }} + + - name: Install `xmlstarlet` + shell: bash + run: sudo apt-get update && sudo apt-get install -y xmlstarlet + + - name: Find the release version major + shell: bash + run: | + revision=$( + xmlstarlet sel \ + -N m=http://maven.apache.org/POM/4.0.0 \ + --template --value-of /m:project/m:properties/m:revision \ + pom.xml + ) + if [[ ! $revision =~ ^[0-9]+\.[0-9]+\.[0-9]+(-SNAPSHOT)?$ ]]; then + echo "Invalid version format: $revision" + exit 1 + fi + parts=(${revision//./ }) + echo "RELEASE_VERSION_MAJOR=${parts[0]}" >> $GITHUB_ENV + + - name: Create changelog entries + shell: bash + run: | + PULL_REQUEST="$RUNNER_TEMP/dependabot-metadata/pull_request.json" + UPDATED_DEPENDENCIES="$RUNNER_TEMP/dependabot-metadata/updated_dependencies.json" + # Generates the content of a changelog entry + function generate_changelog_entry() { + local dependency="$1" + local issue_id=$(xmlstarlet esc "$PR_ID") + local issue_link=$(xmlstarlet esc "$PR_URL") + local dependency_name=$(echo "$dependency" | jq -r '.dependencyName' | xmlstarlet esc) + local new_version=$(echo "$dependency" | jq -r '.newVersion' | xmlstarlet esc) + cat << CHANGELOG_ENTRY + <?xml version="1.0" encoding="UTF-8"?> + <!-- SPDX-License-Identifier: Apache-2.0 --> + <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns="https://logging.apache.org/xml/ns"; + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"; + type="updated"> + <issue id="$issue_id" link="$issue_link"/> + <description format="asciidoc">Update \`$dependency_name\` to version \`$new_version\`.</description> + </entry> + CHANGELOG_ENTRY + } + # Ensure the changelog directory exists + release_changelog_path="src/changelog/.${RELEASE_VERSION_MAJOR}.x.x" + mkdir -p "$release_changelog_path" + cd "$release_changelog_path" + # Generate the changelog entries for each updated dependency + cat "$UPDATED_DEPENDENCIES" | jq --compact-output '.[]' | while read -r dependency; do + # Extract the dependency name and version + dependency_name=$(echo "$dependency" | jq -r '.dependencyName') + changelog_file_name=$(echo "update_${dependency_name,,}.xml" | sed -r -e 's/[^a-z0-9.-]/_/g' -e 's/_+/_/g') + generate_changelog_entry "$dependency" > "$changelog_file_name" + done + + - name: Set up GPG + uses: crazy-max/ghaction-import-gpg@e89d40939c28e39f97cf32126055eeae86ba74ec # 6.3.0 Review Comment: _"In `crazy-max` we trust."_ :tm: We won't be shot by the ASF police for using this, right? ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" + echo "PR_ID=$(jq -r '.number' < "$pull_request")" >> $GITHUB_ENV + echo "PR_URL=$(jq -r '.html_url' < "$pull_request")" >> $GITHUB_ENV + echo "PR_HEAD_REF=$(jq -r '.head.ref' < "$pull_request")" >> $GITHUB_ENV + + - name: Check out repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + with: + ref: ${{ env.PR_HEAD_REF }} + token: ${{ secrets.RECURSIVE_TOKEN }} + + - name: Install `xmlstarlet` + shell: bash + run: sudo apt-get update && sudo apt-get install -y xmlstarlet + + - name: Find the release version major + shell: bash + run: | + revision=$( + xmlstarlet sel \ + -N m=http://maven.apache.org/POM/4.0.0 \ + --template --value-of /m:project/m:properties/m:revision \ + pom.xml + ) + if [[ ! $revision =~ ^[0-9]+\.[0-9]+\.[0-9]+(-SNAPSHOT)?$ ]]; then + echo "Invalid version format: $revision" + exit 1 + fi + parts=(${revision//./ }) + echo "RELEASE_VERSION_MAJOR=${parts[0]}" >> $GITHUB_ENV + + - name: Create changelog entries + shell: bash + run: | + PULL_REQUEST="$RUNNER_TEMP/dependabot-metadata/pull_request.json" + UPDATED_DEPENDENCIES="$RUNNER_TEMP/dependabot-metadata/updated_dependencies.json" + # Generates the content of a changelog entry + function generate_changelog_entry() { + local dependency="$1" + local issue_id=$(xmlstarlet esc "$PR_ID") + local issue_link=$(xmlstarlet esc "$PR_URL") + local dependency_name=$(echo "$dependency" | jq -r '.dependencyName' | xmlstarlet esc) + local new_version=$(echo "$dependency" | jq -r '.newVersion' | xmlstarlet esc) + cat << CHANGELOG_ENTRY + <?xml version="1.0" encoding="UTF-8"?> + <!-- SPDX-License-Identifier: Apache-2.0 --> + <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns="https://logging.apache.org/xml/ns"; + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"; + type="updated"> + <issue id="$issue_id" link="$issue_link"/> + <description format="asciidoc">Update \`$dependency_name\` to version \`$new_version\`.</description> Review Comment: I'd stick to the existing description: ```suggestion <description format="asciidoc">Update \`$dependency_name\` to version \`$new_version\`</description> ``` ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" + echo "PR_ID=$(jq -r '.number' < "$pull_request")" >> $GITHUB_ENV + echo "PR_URL=$(jq -r '.html_url' < "$pull_request")" >> $GITHUB_ENV + echo "PR_HEAD_REF=$(jq -r '.head.ref' < "$pull_request")" >> $GITHUB_ENV + + - name: Check out repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + with: + ref: ${{ env.PR_HEAD_REF }} + token: ${{ secrets.RECURSIVE_TOKEN }} + + - name: Install `xmlstarlet` + shell: bash + run: sudo apt-get update && sudo apt-get install -y xmlstarlet + + - name: Find the release version major + shell: bash + run: | + revision=$( + xmlstarlet sel \ + -N m=http://maven.apache.org/POM/4.0.0 \ + --template --value-of /m:project/m:properties/m:revision \ + pom.xml + ) + if [[ ! $revision =~ ^[0-9]+\.[0-9]+\.[0-9]+(-SNAPSHOT)?$ ]]; then + echo "Invalid version format: $revision" + exit 1 + fi + parts=(${revision//./ }) + echo "RELEASE_VERSION_MAJOR=${parts[0]}" >> $GITHUB_ENV + + - name: Create changelog entries + shell: bash + run: | Review Comment: I'd really appreciate it if you can ventilate this big chunk of code with some empty lines delimiting the blocks by their semantics. ########## src/site/antora/modules/ROOT/examples/analyze-dependabot.yaml: ########## @@ -15,28 +15,18 @@ # limitations under the License. # -name: merge-dependabot +name: "Dependabot Analyze PR" on: - pull_request_target: - paths-ignore: - - "**.adoc" - - "**.md" - - "**.txt" + pull_request: -permissions: read-all +permissions: { } jobs: - build: - if: github.repository == 'apache/logging-parent' && github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]' - uses: ./.github/workflows/build-reusable.yaml - - merge-dependabot: - needs: build - uses: ./.github/workflows/merge-dependabot-reusable.yaml - permissions: - contents: write # to push changelog commits - pull-requests: write # to close the PR - secrets: - GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }} # to sign commits +# tag::analyze-dependabot[] + analyze-dependabot: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} Review Comment: I'd keep the extra check against the repository for DiD reasons: ```suggestion if: ${{ github.repository == 'apache/logging-parent' && github.actor == 'dependabot[bot]' }} ``` (I don't know if above change necessitates an `workflows.adoc` update.) ########## .github/workflows/process-dependabot-reusable.yaml: ########## @@ -0,0 +1,169 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to you under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: Dependabot Process PR + +on: + workflow_call: + inputs: + user-name: + description: The name of the user to use for the commit + default: 'ASF Logging Services RM' + type: string + user-email: + description: The email of the user to use for the commit + default: '[email protected]' + type: string + analyze-workflow-run-id: + description: The ID of the workflow run that analyzed the PR + required: true + type: number + secrets: + RECURSIVE_TOKEN: + description: "A PAT with `contents: write` permission to push changes and trigger the next workflow run" + required: true + GPG_PASSPHRASE: + description: GPG passphrase for signing commits + required: false + GPG_PRIVATE_KEY: + description: GPG secret key for signing commits + required: true + +permissions: { } + +jobs: + + generate-changelog: + # Skip this workflow on commits not pushed by Dependabot + if: ${{ github.actor == 'dependabot[bot]' }} + runs-on: ubuntu-latest + + steps: + + - name: Fetch Dependabot metadata + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # 4.3.0 + with: + github-token: ${{ github.token }} + name: dependabot-metadata + path: ${{ runner.temp }}/dependabot-metadata + run-id: ${{ inputs.analyze-workflow-run-id }} + + - name: Process Dependabot metadata + shell: bash + run: | + # Extract the pull request metadata from the downloaded artifact + path="$RUNNER_TEMP/dependabot-metadata" + if [[ ! -f "$path/pull_request.json" ]]; then + echo "Pull request metadata not found at $path/pull_request.json" + exit 1 + fi + if [[ ! -f "$path/updated_dependencies.json" ]]; then + echo "Updated dependencies metadata not found at $path/updated_dependencies.json" + exit 1 + fi + # Extract the required metadata and set it as environment variables + pull_request="$path/pull_request.json" + echo "PR_ID=$(jq -r '.number' < "$pull_request")" >> $GITHUB_ENV + echo "PR_URL=$(jq -r '.html_url' < "$pull_request")" >> $GITHUB_ENV + echo "PR_HEAD_REF=$(jq -r '.head.ref' < "$pull_request")" >> $GITHUB_ENV + + - name: Check out repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + with: + ref: ${{ env.PR_HEAD_REF }} + token: ${{ secrets.RECURSIVE_TOKEN }} + + - name: Install `xmlstarlet` + shell: bash + run: sudo apt-get update && sudo apt-get install -y xmlstarlet + + - name: Find the release version major + shell: bash + run: | + revision=$( + xmlstarlet sel \ + -N m=http://maven.apache.org/POM/4.0.0 \ + --template --value-of /m:project/m:properties/m:revision \ + pom.xml + ) + if [[ ! $revision =~ ^[0-9]+\.[0-9]+\.[0-9]+(-SNAPSHOT)?$ ]]; then + echo "Invalid version format: $revision" + exit 1 + fi + parts=(${revision//./ }) + echo "RELEASE_VERSION_MAJOR=${parts[0]}" >> $GITHUB_ENV + + - name: Create changelog entries + shell: bash + run: | + PULL_REQUEST="$RUNNER_TEMP/dependabot-metadata/pull_request.json" + UPDATED_DEPENDENCIES="$RUNNER_TEMP/dependabot-metadata/updated_dependencies.json" + # Generates the content of a changelog entry + function generate_changelog_entry() { + local dependency="$1" + local issue_id=$(xmlstarlet esc "$PR_ID") + local issue_link=$(xmlstarlet esc "$PR_URL") + local dependency_name=$(echo "$dependency" | jq -r '.dependencyName' | xmlstarlet esc) + local new_version=$(echo "$dependency" | jq -r '.newVersion' | xmlstarlet esc) + cat << CHANGELOG_ENTRY + <?xml version="1.0" encoding="UTF-8"?> + <!-- SPDX-License-Identifier: Apache-2.0 --> + <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns="https://logging.apache.org/xml/ns"; + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"; + type="updated"> + <issue id="$issue_id" link="$issue_link"/> + <description format="asciidoc">Update \`$dependency_name\` to version \`$new_version\`.</description> + </entry> + CHANGELOG_ENTRY + } + # Ensure the changelog directory exists + release_changelog_path="src/changelog/.${RELEASE_VERSION_MAJOR}.x.x" + mkdir -p "$release_changelog_path" + cd "$release_changelog_path" + # Generate the changelog entries for each updated dependency + cat "$UPDATED_DEPENDENCIES" | jq --compact-output '.[]' | while read -r dependency; do + # Extract the dependency name and version + dependency_name=$(echo "$dependency" | jq -r '.dependencyName') + changelog_file_name=$(echo "update_${dependency_name,,}.xml" | sed -r -e 's/[^a-z0-9.-]/_/g' -e 's/_+/_/g') + generate_changelog_entry "$dependency" > "$changelog_file_name" + done + + - name: Set up GPG + uses: crazy-max/ghaction-import-gpg@e89d40939c28e39f97cf32126055eeae86ba74ec # 6.3.0 + with: + gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} + passphrase: ${{ secrets.GPG_PASSPHRASE }} + + - name: Add & commit changes + shell: bash + env: + USER_NAME: ${{ inputs.user-name }} + USER_EMAIL: ${{ inputs.user-email }} + run: | + git add src/changelog + git config user.name "$USER_NAME" + git config user.email "$USER_EMAIL" + git commit -S -m "Generate changelog entries for PR #$PR_ID" Review Comment: ```suggestion git commit -S -m "Generate changelog entries for #$PR_ID" ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
