Skip to content

Commit 7d9ccb8

Browse files
committed
- Fix review comments.
1 parent dec45d1 commit 7d9ccb8

File tree

3 files changed

+24
-5
lines changed

3 files changed

+24
-5
lines changed

.github/workflows/test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ jobs:
106106
- name: Set PYTHONPATH environment variable
107107
run: echo "PYTHONPATH=${GITHUB_WORKSPACE}/version_tag_check/version_tag_check" >> $GITHUB_ENV
108108

109-
- name: Build and run unit tests
110-
run: pytest --cov=. --cov-report=html tests/ -vv
109+
- name: Check code coverage with Pytest
110+
run: pytest --cov=. -v tests/ --cov-fail-under=80
111111

112112
- name: Check overall coverage
113113
run: |

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Release Notes Presence Checker
22

3+
- [Motivation](#motivation)
4+
- [Requirements](#requirements)
5+
- [Inputs](#inputs)
6+
- [Outputs](#outputs)
7+
- [Usage](#usage)
8+
- [Running Static Code Analysis](#running-static-code-analysis)
9+
- [Run Black Tool Locally](#run-black-tool-locally)
10+
- [Running Unit Test](#running-unit-test)
11+
- [Code Coverage](#code-coverage)
12+
- [Run Action Locally](#run-action-locally)
13+
- [Contribution Guidelines](#contribution-guidelines)
14+
- [License Information](#license-information)
15+
- [Contact or Support Information](#contact-or-support-information)
16+
317
A GH action for validating the presence of release notes in pull requests.
418

519
## Motivation
@@ -29,7 +43,8 @@ This action is designed to help maintainers and contributors ensure that release
2943
- **Required**: Yes
3044

3145
### `location`
32-
- **Description**: The location of the release notes in the pull request. Example: `body`.
46+
- **Description**: The location of the release notes in the pull request.
47+
- **Default**: `body`
3348
- **Required**: No
3449

3550
### `title`
@@ -58,6 +73,10 @@ This action is designed to help maintainers and contributors ensure that release
5873
See the default action step definition:
5974

6075
```yaml
76+
- uses: actions/[email protected]
77+
with:
78+
python-version: '3.11'
79+
6180
- name: Release Notes Presence Check
6281
id: release_notes_presence_check
6382
uses: AbsaOSS/[email protected]
@@ -70,7 +89,7 @@ See the default action step definition:
7089
title: "[Rr]elease [Nn]otes:"
7190
skip-labels: "skip-release-notes,no-release-notes"
7291
fails-on-error: "false"
73-
```
92+
```
7493
7594
## Running Static Code Analysis
7695

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ inputs:
2424
description: 'The repository to check for release notes.'
2525
required: true
2626
location:
27-
description: 'The location of the release notes in the PR. Supported value is "body"'
27+
description: 'The location of the release notes in the PR. Default value is "body"'
2828
required: false
2929
default: 'body'
3030
title:

0 commit comments

Comments
 (0)