#55 - Chapter line formatting - authors #74

miroslavpojer · 2024-09-25T07:37:43Z

Add limitation to avoid of usage black to tests.
Removed workflow copying Release notes from PR to Issue as no more supported.
Updated README.md to show example of row formatting as build-in feature and provide list of supported keywords.

Closes #55
Closes #56

- Add limitation to avoid of usage black to tests. - Removed workflow copying Release notes from PR to Issue as no more supported. - Updated README.md to show example of row formatting as build-in feature and provide list of supported keywords.

…ing-authors

- Fixed structure of test folder.

- Improved validation logic to support difference keywords for issue, pr and commit format rows.

- Improved README to provide better description about format keyword and data sources.

…efault.

miroslavpojer · 2024-10-08T08:07:56Z

Release notes:

add support for formatted row types - Issue, PR and Commit
add support for several placeholders usable in row types
improved doc in README.md
cleanup of code

- Fixed typo in name of files.

MobiTikula

This is part of a partial review. Please comment or implement suggestions mentioned in the comments. During my work on liv-doc, I found as well one more issue.

in a test.yml workflow, there is an issue in unit-test. You check cov with pytest. There is no need to have an html report. You can look at liv-doc for inspiration. After pytest cov check, you check cov again with coverage tool and export it to xml. This is not needed at all, since we just check if cov is above or below 80 %.
if we agree on the point above, you should also remove coverage==7.5.2 from your requirements.txt

README.md

MobiTikula · 2024-10-08T13:14:16Z

README.md

+      - [Handling Issue Mentioned By Multiple PRs](#handling-issue-mentioned-by-multiple-prs)
+      - [No Release Notes Found](#no-release-notes-found)
+      - [Issue, Pull Request or Commit Row formatting](#issue-pull-request-or-commit-row-formatting)
+        - [Supported row format keywords](#supported-row-format-keywords)


There are some bugs, I found during review (README.md), that are already merged. Please find this comment as a block of suggestions, that may occur on more than just one place.

Please reconsider and make a statement about what levels of headers you want to visualize in POC. In my opinion here you go too deep visualizing h5. There are many h3 in inputs section, which are not seen in PoC. It doesn't look compact.

This h5 doesn't really have to be extra header at all. Because there is just one header in the section at the time.

I think that best practice is to have a new header level only, whenever you need @ or more lower level of headings. Easier to see in practice. You have h2 (## Outputs) and then you have just one h3 (### Supported Row Types) and after 3 times h4. I don't see a reason to have this one h3. There is not a single sentence anyway.

The same issue in h5 (##### Supported row format keywords). It is not needed IMHO.

look at line 99 = ### Feature controls, it should be higher level of a header based on the context around.

look at line 150 = #### Default. I am suggesting to change it to Default, since there is no need to have it as a header. Same at line 167.

after Black Expected Output example there is an extra blank line

add information, that pylint and black tool exclude tests/ file

This part will be reworked, including a change of chapter meaning.
This text will not be reused.

Keeping not Resolved to check again after new data structure will be implemented.

README.md

MobiTikula · 2024-10-09T10:28:54Z

release_notes_generator/model/service_chapters.py

                    self.chapters[MERGED_PRS_LINKED_TO_NOT_CLOSED_ISSUES].add_row(nr, records[nr].to_chapter_row())
                    self.used_record_numbers.append(nr)
                else:
                    self.chapters[OTHERS_NO_TOPIC].add_row(nr, records[nr].to_chapter_row())
                    self.used_record_numbers.append(nr)

-    def __populate_closed_issues(self, record: Record, nr: int) -> None:
+    def __populate_isolated_commits(self, r: Record, nr: str) -> None:


Missing method docstring.

Present only in this branch.

MobiTikula · 2024-10-09T10:30:10Z

release_notes_generator/model/service_chapters.py

            self.used_record_numbers.append(nr)

-    def __is_row_present(self, nr: int) -> bool:
+    def __is_row_present(self, nr: int | str) -> bool:


Missing method docstring.

MobiTikula · 2024-10-09T10:31:26Z

release_notes_generator/record/record_factory.py


-        def create_record_for_issue(r: Repository, i: Issue):
-            records[i.number] = Record(r, i)
+        def create_record_for_issue(i: Issue):


Check missing method docstrings.

MobiTikula · 2024-10-09T10:35:09Z

release_notes_generator/utils/decorators.py

@@ -23,7 +23,7 @@
 from functools import wraps
 from typing import Callable, Optional, Any
 from github import GithubException
-from requests.exceptions import Timeout, RequestException, ConnectionError as RequestsConnectionError
+from requests.exceptions import Timeout, RequestException, ConnectionError


ConnectionError is a built in exception, you don't have to import it.

MobiTikula · 2024-10-09T10:36:46Z

release_notes_generator/utils/exceptions.py

@@ -0,0 +1,2 @@
+class NotSupportedException(Exception):


Add all the documentation needed for this new module.

This class is present only this branch.

…ing-authors

miroslavpojer · 2024-10-16T10:46:00Z

This branch will not be used in future.
Review comments will be mined and resolved in time by developer doing the fixed in another branched - with comments here.

miroslavpojer added 30 commits September 25, 2024 09:36

#55 - Chapter line formatting - authors

40a4ee2

- Add limitation to avoid of usage black to tests. - Removed workflow copying Release notes from PR to Issue as no more supported. - Updated README.md to show example of row formatting as build-in feature and provide list of supported keywords.

Merge branch 'refs/heads/master' into feature/55-Chapter-line-formatt…

c58d859

…ing-authors

- Introduced logic and example adding prefix strings as part of keyword.

ec9eb91

- Fixed structure of test folder.

- Fixed wrong keywords. Debug.

17bfaf7

- Remove unexpected import.

7885040

- Fixes from manual test.

f8e90f8

- Fixes from manual test.

9be86e6

- Fixes from manual test.

946368d

- Fixes from manual test.

eb325a5

- Fixes from manual test.

9156996

- Fixes from manual test.

3c6bce8

- Fixes from manual test.

8585cf6

- Fixes from manual test.

ffc4fc6

- Fixes from manual test.

c0a283e

- Fixes from manual test.

1e8b6bc

- Fixes from manual test.

80952d8

- Fixes from manual test.

ad79944

- Fixes from manual test.

67f1961

- Fixes from manual test.

291dd9c

- Fixes from manual test.

daa4b67

- Fixes from manual test.

f6e7647

- Fixes from manual test.

f83b490

- Fixes from manual test.

4e877b2

- Fixes from manual test.

d16adb0

- Fixes from manual test.

5cc9c12

- Fixes from manual test.

81dfaec

- Fixes from manual test.

d42079a

- Fixes from manual test.

5e5d595

- Fixes from manual test.

55c728b

- Fixes from manual test.

ea98398

miroslavpojer added 18 commits October 1, 2024 14:24

- Fixes from manual test.

37bd927

- Fixes from manual test.

3d3c803

- Fixes from manual test.

ba570b3

- Fixes from manual test.

105fffd

- Fixes from manual test.

72609cc

- Fixes from manual test.

d1e4d9a

- Fixes from manual test.

7ced5ad

- Fixes from manual test.

52ceae9

- Fixes from manual test.

cd361e7

- Fixes from manual test.

d32f425

- Fixes from manual test.

9ea0f48

- Fixes from manual test.

7bc3eb6

- Implemented support for developers and contributors.

bdc1872

- The Record class logic split to 4 files.

3285283

- Add support for row format for direct commits.

c118375

- Improved validation logic to support difference keywords for issue, pr and commit format rows.

- Fix commit row format.

d572654

- Improved README to provide better description about format keyword and data sources.

- Pylint and pytest scope reduced. Tests files excluded.

b525e29

- Remove no more supported feature. In new version this behavior is d…

4bd8460

…efault.

miroslavpojer self-assigned this Oct 8, 2024

miroslavpojer marked this pull request as ready for review October 8, 2024 08:06

miroslavpojer requested a review from Zejnilovic as a code owner October 8, 2024 08:06

MobiTikula self-requested a review October 8, 2024 08:18

miroslavpojer added 4 commits October 8, 2024 10:19

- Applied black.

0d2d326

- Fixed problem with few space in bullet list.

abdce26

- Fixed unit tests for utils.py.

20d19ae

- Fixed typo in name of files.

- Fixed unit tests for utils directory.

e6428d7

MobiTikula reviewed Oct 9, 2024

View reviewed changes

Merge branch 'refs/heads/master' into feature/55-Chapter-line-formatt…

f9d4e6c

…ing-authors

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#55 - Chapter line formatting - authors #74

#55 - Chapter line formatting - authors #74

miroslavpojer commented Sep 25, 2024 •

edited

Loading

miroslavpojer commented Oct 8, 2024

MobiTikula left a comment

MobiTikula Oct 8, 2024

miroslavpojer Oct 16, 2024 •

edited

Loading

MobiTikula Oct 9, 2024

miroslavpojer Oct 16, 2024

MobiTikula Oct 9, 2024

miroslavpojer Oct 16, 2024

MobiTikula Oct 9, 2024

miroslavpojer Oct 16, 2024

MobiTikula Oct 9, 2024

miroslavpojer Oct 16, 2024

MobiTikula Oct 9, 2024

miroslavpojer Oct 16, 2024

miroslavpojer commented Oct 16, 2024

#55 - Chapter line formatting - authors #74

Are you sure you want to change the base?

#55 - Chapter line formatting - authors #74

Conversation

miroslavpojer commented Sep 25, 2024 • edited Loading

miroslavpojer commented Oct 8, 2024

MobiTikula left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miroslavpojer Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miroslavpojer commented Oct 16, 2024

miroslavpojer commented Sep 25, 2024 •

edited

Loading

miroslavpojer Oct 16, 2024 •

edited

Loading