coverage comment #17
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# SPDX-FileCopyrightText: Copyright © 2024 Idiap Research Institute <[email protected]> | |
# SPDX-FileContributor: Yannick Dayer <[email protected]> | |
# SPDX-License-Identifier: BSD-3-Clause | |
# Inspired from https://github.com/py-cov-action/python-coverage-comment-action | |
name: coverage comment | |
on: | |
workflow_run: | |
workflows: ["tests"] | |
types: | |
- completed | |
jobs: | |
coverage-comment: | |
name: Send (or modify) a coverage comment to the PR | |
runs-on: ubuntu-22.04 | |
if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' | |
permissions: | |
# Gives the action the necessary permissions for publishing new | |
# comments in pull requests. | |
pull-requests: write | |
# Gives the action the necessary permissions for editing existing | |
# comments (to avoid publishing multiple comments in the same PR) | |
contents: write | |
# Gives the action the necessary permissions for looking up the | |
# workflow that launched this workflow, and download the related | |
# artifact that contains the comment to be published | |
actions: read | |
steps: | |
# DO NOT run actions/checkout here, for security reasons | |
# For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ | |
- name: Post comment | |
uses: py-cov-action/python-coverage-comment-action@v3 | |
with: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }} | |
# Update those if you changed the default values: | |
# COMMENT_ARTIFACT_NAME: python-coverage-comment-action | |
# COMMENT_FILENAME: python-coverage-comment-action.txt |