Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Feature/52 introduce topics #63

Merged
merged 15 commits into from
Nov 14, 2024
Merged

Feature/52 introduce topics #63

merged 15 commits into from
Nov 14, 2024

Conversation

MobiTikula
Copy link
Collaborator

@MobiTikula MobiTikula commented Nov 5, 2024 •
edited by miroslavpojer
Loading

Introduce topics into the project

  • Add new input control to enable Topic grouping in the output.
  • Add the logic to group Features to stand-alone tables in main _index.page.
  • Update the README.md file with new feature
  • Update yaml file for CI run
  • Check the correct behavior at mdoc viewer page

Release Notes:

  • New user feature, that provides an option of grouping issues by Topics.

Closes #52

@MobiTikula MobiTikula self-assigned this Nov 5, 2024
miroslavpojer
miroslavpojer reviewed Nov 6, 2024
View reviewed changes
Copy link
Collaborator

@miroslavpojer miroslavpojer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • pulled
  • local run done
  • pylint checked
  • unit tests ran

I am missing unit tests for newly added methods in test suites which have been already implemented.
I see problem with current Outpus logic solution It will be addressed in following issue.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
living_documentation_generator/model/consolidated_issue.py Show resolved Hide resolved
living_documentation_generator/model/consolidated_issue.py Outdated Show resolved Hide resolved
living_documentation_generator/generator.py
if ActionInputs.get_is_structured_output_enabled():
self._generate_structured_index_pages(index_repo_level_template, index_org_level_template, issues)
# Generate all structure of the index pages
if is_structured_output:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This if-elif is strange as both can happen in same time.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understand your statement. The logic is quite complex, I like this approach tho. I am open to your suggestions. I don't see other way to accomplish the goal at the moment.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not able to provide a better proposal too.
Let's fix it in a dedicated issue.

@MobiTikula
Copy link
Collaborator Author

I did add a unit test for new logic, see commit: dadffcc.

@miroslavpojer miroslavpojer merged commit fdb2f09 into master Nov 14, 2024
3 of 4 checks passed
@miroslavpojer miroslavpojer deleted the feature/52-Introduce-Topics branch November 14, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@miroslavpojer miroslavpojer miroslavpojer approved these changes

@Zejnilovic Zejnilovic Awaiting requested review from Zejnilovic Zejnilovic is a code owner

Assignees

@MobiTikula MobiTikula

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Introduce Topics
2 participants
@MobiTikula @miroslavpojer