Skip the license header check step in `check-license-header.yaml` workflow when no files with configured extensions were changed in the pull request. Previously, the workflow would fail in this case since the --files argument requires at least one file path: ``` check-license.py: error: argument --files: expected at least one argument ``` Add `if` condition to only run the check when steps.changed-files.outputs.files is not empty. Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
51 lines
1.7 KiB
YAML
51 lines
1.7 KiB
YAML
name: License Header Check
|
|
|
|
on:
|
|
pull_request:
|
|
types: [opened, synchronize, reopened]
|
|
branches: [master]
|
|
|
|
env:
|
|
HEADER_CHECK_LINES: 10
|
|
LICENSE: "LicenseRef-ScyllaDB-Source-Available-1.0"
|
|
CHECKED_EXTENSIONS: ".cc .hh .py"
|
|
|
|
jobs:
|
|
check-license-headers:
|
|
name: Check License Headers
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Get changed files
|
|
id: changed-files
|
|
run: |
|
|
# Get list of added files comparing with base branch
|
|
echo "files=$(git diff --name-only --diff-filter=A ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | tr '\n' ' ')" >> $GITHUB_OUTPUT
|
|
|
|
- name: Check license headers
|
|
if: steps.changed-files.outputs.files != ''
|
|
run: |
|
|
.github/scripts/check-license.py \
|
|
--files ${{ steps.changed-files.outputs.files }} \
|
|
--license "${{ env.LICENSE }}" \
|
|
--check-lines "${{ env.HEADER_CHECK_LINES }}" \
|
|
--extensions ${{ env.CHECKED_EXTENSIONS }}
|
|
|
|
- name: Comment on PR if check fails
|
|
if: failure()
|
|
uses: actions/github-script@v7
|
|
with:
|
|
script: |
|
|
const license = '${{ env.LICENSE }}';
|
|
await github.rest.issues.createComment({
|
|
issue_number: context.issue.number,
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
body: `❌ License header check failed. Please ensure all new files include the header within the first ${{ env.HEADER_CHECK_LINES }} lines:\n\`\`\`\n${license}\n\`\`\`\nSee action logs for details.`
|
|
});
|