Skip to content

Latest commit

 

History

History
765 lines (410 loc) · 26.8 KB

CHANGELOG.md

File metadata and controls

765 lines (410 loc) · 26.8 KB

Changelog of the Pytest Coverage Comment

Release Date: 2026-11-08

Changes

  • fix the multiple-files table breaking when a component's coverage files are missing (e.g. its tox env failed) — a blank line was added inside the table, so GitHub rendered the following rows as plain text (#327), thanks to @h0nIg for contribution
  • README examples now fail the test step when pytest fails (shell: bash enables pipefail, so pytest | tee no longer hides the exit code) and still post the coverage comment with if: ${{ !cancelled() }} (#325, #329), thanks to @ArturKlauser for contribution

Release Date: 2026-10-26

Changes

  • new annotate-missing-lines option: adds GitHub annotations on lines added in the pull request or push that aren't covered by tests (missing lines and partial branches), shown right below the code in the "Files changed" tab. Works with txt, xml and json coverage on pull_request, pull_request_target and push events. Combine it with hide-comment: true to get annotations without a PR comment, fixes #321
  • new annotation-type option to set the annotation level: notice, warning (default) or error
  • coverage-path-prefix is now stripped only from the start of a changed file's path (previously the first match anywhere in the path was removed)

Release Date: 2026-10-24

Changes

  • escape report values in the coverage table and keep them out of markdown parsing, so a crafted coverage report can't inject HTML, markdown, links or a fake badge into the comment
  • url-encode file paths in coverage table links, don't link paths with .., support windows \ paths, and strip the workspace prefix from missing-line links
  • fix a crash when a coverage report has a top-level folder named like an Object member (e.g. constructor)

Release Date: 2026-10-24

Changes

  • bump dev dependencies: vitest 5.0.5, @vitest/coverage-v8 5.0.5, @types/node 26.6.5, eslint 10.13.0, typescript-eslint 8.72.0, prettier 3.9.10, vite 8.3.5
  • bump undici from 6.29.0 to 6.29.1 (fixes two high severity vulnerabilities)

Release Date: 2026-10-03

Changes

  • bump dev dependencies: vitest 5.0.3, @vitest/coverage-v8 5.0.3, @types/node 26.6.4, eslint 10.12.0, typescript-eslint 8.71.0, prettier 3.9.9 (#309)
  • bump undici from 6.28.0 to 6.29.0 (#309)
  • bump brace-expansion from 5.0.8 to 5.0.12 (fixes four security vulnerabilities) (#309)

Release Date: 2026-09-01

Changes

  • bump dev dependencies: @types/node 26.4.0, @vercel/ncc 0.45.0, @vitest/coverage-v8 4.1.11, vitest 4.1.11, eslint 10.9.1, typescript-eslint 8.68.0 (#302)

Release Date: 2026-08-30

Changes

  • fix a rare case where the comment was still too long and failed to post — it's now always truncated to fit GitHub's limit (#301), fixes #299

Release Date: 2026-08-30

Changes

  • show a warning inside the comment itself when it's too long (over 65,536 characters) and the detailed coverage report gets dropped — previously the report silently disappeared and the reason was only visible in the job log. The warning links to the job log, which lists the ways to reduce the comment size (#298), thanks to @mschoettle for contribution

Release Date: 2026-08-26

Changes

  • improve the comment message when report-only-changed-files is enabled and none of the changed files appear in the coverage report — it now says "No changed files were found in the coverage report" instead of the misleading "No files were changed during this commit" (#296), thanks to @mschoettle for contribution

Release Date: 2026-08-22

Changes

  • bump undici from 6.27.0 to 6.28.0 (fixes three security vulnerabilities)

Release Date: 2026-08-02

Changes

  • add show-failed-tests input that lists failed tests (up to max-failed-tests) in the comment as a collapsible block with the test name linked to its file, a short failure reason and the pytest output (#293), requested in #26
  • add max-failed-tests input to cap the number of shown failed tests (30 by default, in total across all junit files, shared with multiple-files mode) (#293)
  • add failedTestsHtml output with the rendered block, empty when the option is disabled or all tests pass (#293)

Release Date: 2026-08-01

Changes

  • bump dev dependencies: @types/node 26.1.2, @vitest/coverage-v8 4.1.10, vitest 4.1.10, eslint 10.8.0, typescript-eslint 8.65.0, prettier 3.9.6 (#290)
  • bump brace-expansion from 5.0.6 to 5.0.8 (#287)
  • bump schneegans/dynamic-badges-action from 1.8.0 to 1.9.0 in workflows (#289)

Release Date: 2026-07-05

Changes

  • add support for parsing the JSON coverage report from coverage json via the new pytest-json-coverage-path input, including branch coverage and partial-branch arrows (line->target, line->exit) that match coverage report -m (#286)

Release Date: 2026-07-04

Changes

  • fix the Coverage percentage when branch coverage is enabled — it now combines statement and branch coverage and rounds the same way coverage report does, instead of showing 100% when branches are only partially covered (#284), thanks to @mschoettle for contribution

Release Date: 2026-06-27

Changes

  • show partially-covered branches as line->target arrows in the Missing column when parsing XML coverage (pytest-xml-coverage-path), matching the output of coverage report --show-missing (#274), thanks to @mschoettle for contribution

Release Date: 2026-06-27

Changes

  • bump @vercel/ncc 0.38.4 → 0.44.0 (Node 24/26 + TypeScript 6 support)
  • bump dev dependencies: @types/node 26.0.1, vitest 4.1.9, eslint 10.6.0, typescript-eslint 8.62.0, prettier 3.8.5

Release Date: 2026-04-18

Changes

  • bump dev dependencies: typescript 6.0.3, vitest 4.1.4, eslint 10.2.1, typescript-eslint 8.58.2

Release Date: 2026-03-14

Changes

  • fix 5 security vulnerabilities in undici (6.23.0 → 6.24.1) (#260)
  • bump dev dependencies

Release Date: 2026-03-13

Changes

  • enable immutable releases for supply chain security (#256)
  • bump flatted from 3.3.3 to 3.4.1 to fix security vulnerability

Note: No changes to action inputs, outputs, or behavior. This improves release security following GitHub's immutable releases feature.

Release Date: 2026-03-06

Changes

  • migrate codebase from JavaScript to TypeScript
  • add unit tests (91 tests) using Vitest with V8 coverage

Note: This is an internal rewrite — no changes to action inputs, outputs, or behavior. Fully backward compatible.

Release Date: 2026-02-28

Changes

  • feat: add hide-emoji option to hide emoji shortcodes from the test summary table (#251)
  • docs: update README examples to use @v1 tag and latest action versions (checkout@v6, setup-python@v6)

Release Date: 2026-02-22

Changes

  • feat: auto-detect and display branch coverage columns (Branch, BrPart) in coverage table (#110)
  • supported for both text format (pytest --cov --cov-branch) and XML format (coverage.xml)
  • no new action inputs required — columns appear automatically when branch data is present
  • fully backward compatible — existing users see no change

Release Date: 2026-02-21

Changes

  • feat: add XML coverage support in multiple-files mode (#200), thanks to @hayes0724 for contribution
  • multiple-files input now auto-detects XML coverage files by .xml extension
  • allows mixing TXT and XML coverage formats in the same multi-file report (useful for monorepos)
  • add safety check for XML coverage structure to prevent runtime errors

Release Date: 2026-02-21

Changes

  • fix fork PR permission error with specific guidance for pull_request_target (#243)
  • bump production deps: @actions/core to 2.0.3, @actions/github to 8.0.1
  • bump dev deps: eslint to 10.0.1, globals to 17.3.0, prettier to 3.8.1
  • upgrade action runtime from node20 to node24
  • fix comment-too-long code path not replacing HTML with shorter report

Release Date: 2025-11-15

Changes

  • feat: add text-instead-badge option to display coverage as simple text instead of badge images (#235)
  • text format displays as XX% (covered/total) (e.g., 85% (42/50))
  • applies to all coverage reports: main summary and multiple-files tables
  • fully backward compatible - badge mode remains the default
  • feat: add automatic server URL detection for self-hosted GitHub instances (#234)

Note: Starting from this version, version bumps follow conventional semantic versioning (MAJOR.MINOR.PATCH) instead of only bumping PATCH versions.

Release Date: 2025-11-08

Changes

  • fix "Resource not accessible by integration" error with better error handling and documentation (#68)
  • update permission examples to show minimal required permissions (contents: read, pull-requests: write)
  • upgrade package-lock.json from lockfileVersion 2 to 3 (causes extensive but cosmetic changes in dist/index.js)

Release Date: 2025-11-08

Changes

  • fix handling of annotated git tags in push events (#195)
  • update @actions/github from v4.0.0 to v6.0.1 (#229)
  • fix 3 security vulnerabilities in Octokit dependencies

Release Date: 2025-08-30

Changes

  • fix coverageHtml output empty when using XML coverage files (#204)
  • ensure proper HTML generation for both text and XML coverage file types

Release Date: 2025-08-09

Changes

  • fix GitHub Actions matrix syntax parsing error in action.yml (#214)

Release Date: 2025-08-09

Changes

  • fix GitHub Action Summary size limit error by implementing automatic truncation for summaries exceeding 1MB (#209)
  • add remove-links-to-files and remove-links-to-lines options to reduce comment size by removing clickable links
  • improve README with collapsible sections, better examples, and comprehensive troubleshooting guide
  • align action.yml descriptions with README for consistency and clarity
  • enhance comment size warning system with suggestions for new link removal options
  • bump dev dependencies

Release Date: 2025-04-30

Changes

  • add support for new format for pytest-coverage-path, basically it add support for output of pytest-cov >= 6.0.0
  • bump dev dependencies

Release Date: 2024-10-10

Changes

  • add option xml-skip-covered to skip lines that covered for 100% based on xml report, thanks to @NikTerentev for contribution
  • bump dev dependencies and minor for @actions/core

Release Date: 2024-06-30

Changes

  • fix commit sha and ref for workflow_run, instead of from the default branch, thanks to @cecheta for contribution
  • use label instead of ref for workflow_run and workflow_dispatch, thanks to @cecheta for contribution
  • use data from all testsuites instead the first one, thanks to @eltoder for contribution

Release Date: 2024-01-13

Changes

  • add workflow_run to the events that can trigger this action, big thanks to @Bouni for contribution

Release Date: 2023-11-26

Changes

  • add support for updateing the comment in PR through workflow_dispatch event by passing manually issue number, thanks to @alexjyong for contribution

Release Date: 2023-11-15

Changes

  • remove warning by run in node20 instead node16
  • add support for workflow_dispatch event, thanks to @f100024 for contribution

Release Date: 2023-08-02

Changes

  • Fix wrong badge link when have an empty space in total coverage

Release Date: 2023-03-18

Changes

  • Fix generating coverage report when all files skip-covered

Release Date: 2023-03-03

Changes

  • Fix broken links that include double underscores like __init__.py
  • Bump dev dependencies

Release Date: 2023-02-04

Changes

  • Fix commit sha in links when event is pull_request_target

Release Date: 2023-01-31

Changes

  • Support pull_request_target event to add comments
  • Bump dev dependencies

Release Date: 2023-01-23

Changes

  • Export right stms when using pytest-xml-coverage-path, thanks to @ricardolsmendes for contribution
  • Fix some typos in comments

Release Date: 2023-01-09

Changes

  • Update the previous comment with non-default github-token

Release Date: 2022-12-24

Changes

  • Fix output of the coverage when using only pytest-xml-coverage-path

Release Date: 2022-12-03

Changes

  • Support for url for github enterprise repositories, thanks to @jbcumming for contribution
  • Minor readme improvements, thanks to @AlexanderLanin for contribution

Release Date: 2022-11-26

Changes

  • Support matrix with individual comments. When you run in a matrix, and you want that every job will post a comment, you can use the unique-id-for-comment: ${{ matrix.python-version }}. This will post a comment for every job, and will update them on every run.

Release Date: 2022-11-26

Changes

  • Fix when using multiple-files table is not formatted correctly, because of the column count mismatch thanks to @jbcumming for contribution

Release Date: 2022-10-20

Changes

  • Fix failing the action when the event type is not pull_request/push. Now it will just post warning message if you try to comment (and not fail the whole action). If you just using an output of the action you will be able to run this action on events like schedule/workflow_dispatch etc
  • Add full CHANGELOG.md (current file with all history). Those whos use dependabot now will be able to see the changes directly in the PR

Release Date: 2022-10-12

Changes

  • Upgrade node12 to node16(otherwise GitHub print warning on that)

Release Date: 2022-09-06

Changes

  • fix empty folders on changed files (the report show empty folders even they don't contain files)

Release Date: 2022-09-06

Changes

  • fix warning when use coverage-xml

Release Date: 2022-08-29

Changes

  • add support for coverage.xml, thanks to @xportation for contribution

Release Date: 2022-08-10

Changes

  • add multi files to coverage report

Release Date: 2022-08-09

Changes

  • Add option to remove link on badge remove-link-from-badge

Release Date: 2022-08-05

Changes

Release Date: 2022-06-29

Changes

  • fix changed files (when the first commit comes in push evnet, it fails to compare it with head commit)

Release Date: 2022-04-27

Changes

  • Add comment to report when no files changed:
    report-only-changed-files is enabled. No files were changed during this commit :)

Release Date: 2022-04-26

Changes

  • fix parse on big files

Release Date: 2022-04-22

Changes

  • show elapsed time in minutes when it's more than 60 seconds
  • If the elapsed time is more than 1 minute, it will show it in a different format (555.0532s > 9m 15s), the output format will be the same as junit.xml (555.0532s).

Release Date: 2022-04-22

Changes

  • Elapsed time in minutes

Release Date: 2022-04-06

Changes

  • Fix ahead of base commit

Release Date: 2022-03-15

Changes

  • Correct coverage header words to include

Release Date: 2022-03-14

Changes

  • prefix to changed files

Release Date: 2022-03-12

Changes

  • fix missing lines

Release Date: 2022-03-10

Changes

  • add links in comment with prefix

Release Date: 2022-03-08

Changes

  • fix cover td

Release Date: 2022-02-24

Changes

  • fix cover export with old syntax

Release Date: 2022-02-24

Changes

  • fix cover percentage when using cov-branch

Release Date: 2022-01-21

Changes

  • add option to reportOnlyChangedFiles

Release Date: 2021-12-09

Changes

  • fix table when missing column are not there

Release Date: 2021-12-09

Changes

  • fix repository name when undefined
    Thanks to @OTooleMichael for contribution

Release Date: 2021-12-04

Changes

  • fix repository name when run on schedule

Release Date: 2021-12-01

Changes

  • fix parsing issues in some cases

Release Date: 2021-11-11

Changes

  • Add summary report to output to multiFiles

Release Date: 2021-10-31

Changes

  • add warnings to output

Release Date: 2021-10-16

Changes

  • fork for notSuccessTestInfo

Release Date: 2021-09-08

Changes

  • add values from to output variables

Release Date: 2021-09-08

Changes

  • add coverageHtml to multiFiles mode

Release Date: 2021-09-08

Changes

  • Export coverage example

Release Date: 2021-07-26

Changes

  • Add option to hide the comment (will generate only the output)

Release Date: 2021-07-17

Changes

  • fix error body to long

Release Date: 2021-07-13

Changes

  • add output for first file when multiple files mode enabled

Release Date: 2021-06-24

Changes

  • fix validation of a coverage file

Release Date: 2021-06-23

Changes

  • add check if coverage file is valid

Release Date: 2021-06-19

Changes

  • ignore files that didn't exists in multi-mode

Release Date: 2021-06-15

Changes

  • Multiple Files Mode (can be useful on mono-repo projects) Result Multiple Files Mode Example

Release Date: 2021-06-15

Changes

  • improove watermark

Release Date: 2021-06-02

Changes

  • Initial publication on GitHub. The first release of the action.