Skip to content
Compare
Choose a tag to compare
@ZainAmjad68 ZainAmjad68 released this 20 Sep 11:57
· 4 commits to main since this release

Test Coverage Annotate - GitHub Action Release Notes

Version 1.1

Full Changelog: v1.0...v1.1

New Features

  • Added support for displaying test coverage annotations directly on pull requests.
  • Introduced the token input to interact with the GitHub API for pull request details.
  • Added the coverage-info-path input to specify the path to the coverage report file.
  • Included the annotation-coverage input to customize the style of coverage annotations.
  • Introduced the annotation-type input to specify the type of coverage aspects to annotate.

Enhancements

  • Improved integration with pull request workflows for a seamless experience.
  • Enhanced the customization options for annotation style, allowing users to choose between 'summarize' and 'detailed' annotations.
  • Added flexibility in specifying the coverage aspects to annotate, including 'lines', 'functions', 'branches', and 'all'.
  • Streamlined configuration with sensible default values.

Example Usage

uses: your-username/[email protected]
with:
  token: ${{ secrets.GITHUB_TOKEN }}
  coverage-info-path: './coverage/lcov.info'
  annotation-coverage: 'detailed'
  annotation-type: 'all'

Breaking Changes

  • None

Bug Fixes

  • Fixed instance where a whitespace only line change was not processed correctly

Documentation

  • Updated README with detailed information on how to use the action and its configuration options.
  • Added examples for different use cases to make setup easier for users.

Notes

  • This is the initial release of Test Coverage Annotate GitHub Action, providing developers with actionable insights into code coverage during the code review process.