-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#92 - Add support for more characters as markdown list rows #93
Conversation
- Implemented support for + and * characters.
- Removed the need to provide # in template of row - for record number. - Update of pull-request to GitHub link type. Removed Markdown format of link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please implement the comments I mentioned in this review.
-
Please read comments, I already made about README file in big review supporting Authors last week. Suggesting fixing all the points mentioned there.
-
Also I detected an extra TODO in .pylintrc, please get rid off it.
As Unit tests fixed in commit - 8d46ba8. |
- Reformat of cov-report output format definition.
- Removed no more required workflow for copying Release notes comments from PR to Issues. - Update logic of "skip-release-notes-check" label check presence.
- Added check for `+` character as valid detection of Release notes line.
README.md
Outdated
|
||
## Code Coverage | ||
|
||
Code coverage is collected using pytest-cov coverage tool. To run the tests and collect coverage information, use the following command: | ||
|
||
``` | ||
pytest --cov=release_notes_generator --cov-report html tests/ | ||
pytest --cov=release_notes_generator --cov-report=html tests/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be pytest --cov=. tests/ --cov-report=html
. In your version, you don't do a coverage of main script and setup.py.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To fully complete this PR before release, please reconsider to implement these points:
- You are using new version of Release Notes generator, where you write Release Notes comment into the body of PR. But the workflow Release Notes check is outdated. You should update the workflow for this project as well.
- I don't feel your way, how to check code coverage. As I mentioned before, you use coverage as well as pylint in one workflow. All your coverage check can be done in 2 rows of code. You can get inspiration in Living Doc repo.
There are few little things catched by pylint tool, you should solve as well.
- setup.py:1:0: C0114: Missing module docstring (missing-module-docstring)
- release_notes_generator/utils/pull_reuqest_utils.py:1:0: C0114: Missing module docstring (missing-module-docstring)
- release_notes_generator/model/record.py: TODO (42, 129, 190)
- release_notes_generator/builder.py: TODO (32)
- release_notes_generator/model/record.py:50:8: W0238: Unused private member
Record.__repo
(unused-private-member) - release_notes_generator/model/record.py:132:4: W0102: Dangerous default value RELEASE_NOTE_LINE_MARKS (builtins.list) as argument (dangerous-default-value)
…and use in workflows.
|
#92 - Add support for more characters as markdown list rows
#91 - Placeholder {number} does not # before Issue or PR number
Closes #92
Closes #91
Release Notes: