Skip to content

Commit

Permalink
- Fix review comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
miroslavpojer committed Nov 18, 2024
1 parent dec45d1 commit 7d9ccb8
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ jobs:
- name: Set PYTHONPATH environment variable
run: echo "PYTHONPATH=${GITHUB_WORKSPACE}/version_tag_check/version_tag_check" >> $GITHUB_ENV

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

- name: Check overall coverage
run: |
Expand Down
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Release Notes Presence Checker

- [Motivation](#motivation)
- [Requirements](#requirements)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Usage](#usage)
- [Running Static Code Analysis](#running-static-code-analysis)
- [Run Black Tool Locally](#run-black-tool-locally)
- [Running Unit Test](#running-unit-test)
- [Code Coverage](#code-coverage)
- [Run Action Locally](#run-action-locally)
- [Contribution Guidelines](#contribution-guidelines)
- [License Information](#license-information)
- [Contact or Support Information](#contact-or-support-information)

A GH action for validating the presence of release notes in pull requests.

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

### `location`
- **Description**: The location of the release notes in the pull request. Example: `body`.
- **Description**: The location of the release notes in the pull request.
- **Default**: `body`
- **Required**: No

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

```yaml
- uses: actions/[email protected]
with:
python-version: '3.11'

- name: Release Notes Presence Check
id: release_notes_presence_check
uses: AbsaOSS/[email protected]
Expand All @@ -70,7 +89,7 @@ See the default action step definition:
title: "[Rr]elease [Nn]otes:"
skip-labels: "skip-release-notes,no-release-notes"
fails-on-error: "false"
```
```
## Running Static Code Analysis
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ inputs:
description: 'The repository to check for release notes.'
required: true
location:
description: 'The location of the release notes in the PR. Supported value is "body"'
description: 'The location of the release notes in the PR. Default value is "body"'
required: false
default: 'body'
title:
Expand Down

0 comments on commit 7d9ccb8

Please sign in to comment.