Skip to content

Commit 9ed21a5

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

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -102,24 +102,20 @@ Pylint displays a global evaluation score for the code, rated out of a maximum s
102102
python3 -m venv venv
103103
source venv/bin/activate
104104
pip install -r requirements.txt
105-
106-
# run your commands
107-
108-
deactivate
109105
```
110106

111107
This command will also install a Pylint tool, since it is listed in the project requirements.
112108

113109
### Run Pylint
114110
Run Pylint on all files that are currently tracked by Git in the project.
115-
```
111+
```shell
116112
pylint $(git ls-files '*.py')
117113
```
118114

119115
To run Pylint on a specific file, follow the pattern `pylint <path_to_file>/<name_of_file>.py`.
120116

121117
Example:
122-
```
118+
```shell
123119
pylint ./release_notes_presence_check/release_notes_presence_check_action.py
124120
```
125121

@@ -159,7 +155,7 @@ black ./release_notes_presence_check/release_notes_presence_check_action.py
159155

160156
### Expected Output
161157
This is the console expected output example after running the tool:
162-
```
158+
```shell
163159
All done! ✨ 🍰 ✨
164160
1 file reformatted.
165161
```
@@ -168,7 +164,7 @@ All done! ✨ 🍰 ✨
168164

169165
Unit tests are written using pytest. To run the tests, use the following command:
170166

171-
```
167+
```shell
172168
pytest tests/
173169
```
174170

@@ -178,16 +174,16 @@ This will execute all tests located in the tests directory.
178174

179175
Code coverage is collected using pytest-cov coverage tool. To run the tests and collect coverage information, use the following command:
180176

181-
```
182-
pytest --cov=. --cov-report=html tests/
177+
```shell
178+
pytest --cov=. -v tests/ --cov-fail-under=80
183179
```
184180

185181
This will execute all tests located in the tests directory and generate a code coverage report.
186182

187183
See the coverage report on the path:
188184

189-
```
190-
htmlcov/index.html
185+
```shell
186+
open htmlcov/index.html
191187
```
192188

193189
## Run Action Locally

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ target-version = ['py311']
44
force-exclude = '''test'''
55

66
[tool.coverage.run]
7-
omit = ["tests/*", "main.py", "version_tag_check/github_repository.py"]
7+
omit = ["tests/*", "main.py", "release_notes_presence_check/github_repository.py"]

0 commit comments

Comments
 (0)