search

AbsaOSS / generate-release-notes

Efficiently automate your release note generation with 'generate-release-notes'. This GH action scans your target GitHub repository's issues, sorting and organizing them into well-formatted release notes. Perfect for maintaining a streamlined and organized release process.
Apache License 2.0
9 stars 0 forks source link

#92 - Add support for more characters as markdown list rows #93

Closed miroslavpojer closed 1 month ago

miroslavpojer commented 1 month ago

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:

miroslavpojer commented 1 month ago

As Release Notes: review comment was fixed, there is needed to fix the unit tests and update workflow to to be synced with the code and look for exact string.

Unit tests fixed in commit - 8d46ba8bfca8af446f03bb33918e3c8986fb7099. Workflow check example fixed in commit - TBD.

miroslavpojer commented 1 month ago

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)