Merge pull request #128 from cicirello/prep-release

Prepare release 2.10.0
cicirello · Sep 4, 2023 · 0f2af7c · 0f2af7c
2 parents f0dd6f6 + 09d54d2
commit 0f2af7c
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,10 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] - 2023-09-03
+## [Unreleased] - 2023-09-04
 
 ### Added
-* Option to suppress workflow job summary in GitHub Actions Mode.
 
 ### Changed
 
@@ -18,11 +17,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 ### Dependencies
-* Bump cicirello/pyaction from 4.19.0 to 4.22.0
 
 ### CI/CD
 
 
+## [2.10.0] - 2023-09-04
+
+### Added
+* Option to suppress workflow job summary in GitHub Actions Mode (#126).
+
+### Dependencies
+* Bump cicirello/pyaction from 4.19.0 to 4.22.0
+
+
 ## [2.9.0] - 2023-05-24
 
 ### Added

diff --git a/README.md b/README.md
@@ -530,6 +530,12 @@ decreased since it is more precise than the truncated coverage percentage stored
 the badge or Shields endpoint. __Therefore, when using this feature, it is recommended that
 you also set `generate-summary: true` and commit the summary report JSON file to the repository.__
 
+#### `generate-workflow-summary`
+
+This input controls whether or not to log the coverage percentages to the GitHub Actions
+Workflow Job Summary. The default is `generate-workflow-summary: true`. This input is only 
+relevant when running in GitHub Actions mode, and not when running as a CLI tool.
+
 
 ### Outputs
 
@@ -659,7 +665,7 @@ You can also use a specific release with:
 
 ```yml
     - name: Generate JaCoCo Badge
-      uses: cicirello/jacoco-badge-generator@v2.9.0
+      uses: cicirello/jacoco-badge-generator@v2.10.0
       with:
         generate-branches-badge: true
 ```
@@ -697,6 +703,7 @@ what these inputs do.
         fail-if-branches-less-than: 0
         fail-on-coverage-decrease: false
         fail-on-branches-decrease: false
+        generate-workflow-summary: true
 ```
 
 Since the above shows all of the default values of the action inputs, 
@@ -1219,6 +1226,7 @@ you do not need to include them.
 | `fail-if-branches-less-than: 0` | `--fail-if-branches-less-than 0` |
 | `fail-on-coverage-decrease: false` | `--fail-on-coverage-decrease false` |
 | `fail-on-branches-decrease: false` | `--fail-on-branches-decrease false` |
+| `generate-workflow-summary: true` | n/a |
 
 ## Blog Posts
 

diff --git a/action.yml b/action.yml
@@ -1,7 +1,7 @@
 # jacoco-badge-generator: Coverage badges, and pull request coverage checks, 
 # from JaCoCo reports in GitHub Actions
 # 
-# Copyright (c) 2020-2021 Vincent A Cicirello
+# Copyright (c) 2020-2023 Vincent A Cicirello
 # https://www.cicirello.org/
 #
 # MIT License

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "jacoco-badge-generator"
-version = "2.9.0"
+version = "2.10.0"
 authors = [
   { name="Vincent A. Cicirello", email="[email protected]" },
 ]