Feature/57 prepare action inputs for several regimes

[MobiTikula]

This PR creates a breaking change of restructuring the project to be able to add multiple mining regimes to the generator in the future (generator is supposed to support CI mining, Incident mining etc.). This PR was done in several steps:

1. Adding a new logic into the .yaml file for supporting multiple regimes
2. Current generator renaming into the living documentation generator and relative scripts added into living_documentation_regime folder.
3. Folder restructuring: utils in the root folder, templates with extra distribution into separate regime folders, tests have new folder structure as well.
4. Main.py logic is updated to the future option of having more regimes.
5. Links between the scripts updated based on new project folder structure.
6. Adding tests, checking black, pylint
7. Creating new Readme, so there are currently two in the repo: one for the overall information about the GH Action, one just for the regime, describing the function, activation, features etc.

Release Notes:

• New Action Input logic affecting the current way of use.
• New project folder structure.
• New logic accepting more than just one mining regime.
• New way of writing the documentation via multiple README.md.

Closes #57

[miroslavpojer]

• pulled
• code review
• unit tests ran
• local run performed.

During local run I have observed these issues (decide if fix here or in solo issue):

• 2024-11-29 13:50:24 - DEBUG - KeyError('number') occurred while parsing issue json: {'content': {}, 'fieldValues': {'nodes': [{'__typename': 'ProjectV2ItemFieldUserValue'}, {'__typename': 'ProjectV2ItemFieldRepositoryValue'}, {'__typename': 'ProjectV2ItemFieldLabelValue'}, {'__typename': 'ProjectV2ItemFieldReviewerValue'}, {'__typename': 'ProjectV2ItemFieldTextValue'}, {'__typename': 'ProjectV2ItemFieldSingleSelectValue', 'name': 'Done'}]}}.
• 2024-11-29 13:50:24 - DEBUG - Method get_project_issues returned [<living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074d3310>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f33d0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f1f50>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f0910>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f2650>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f02d0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f2550>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f36d0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f2490>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074f0610>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f150>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f050>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f390>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f510>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f790>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f7d0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f810>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f690>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f650>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11183f4d0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074efd10>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1074efdd0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11185fb90>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11185fc50>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11185fd50>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11185fe10>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11185fed0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x11185ff90>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111868090>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111868150>, <living_documentation_regime.model.project_issue.ProjectIssue object
• 2024-11-29 13:50:25 - DEBUG - Method get_project_issues returned [<living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854290>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854b10>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854810>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854310>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854210>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854190>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854110>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111847610>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x1118479d0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111854490>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111847910>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111847ad0>, <living_documentation_regime.model.project_issue.ProjectIssue object at 0x111847c50>, <living_documentation_regime.model.project_issue.ProjectIssue object a

Issues are wrong log messages. Their output is not readable for end user.

[MobiTikula]

The DEBUG logging comment was solved in commit: ae71977.

[miroslavpojer]

• pulled
• local run
• code review

[miroslavpojer]

• pulled
• local ran
• code review

Remove unexp[ected change of input type format.
Confirm action is usable from CI.

[miroslavpojer]

• pulled
• core revide
• local ran
• CI ran

[miroslavpojer]

Suggested change

	# Environment variables for LivDoc regime functionality
	# Environment variables for Living Documentation (LivDoc) regime functionality

[MobiTikula]

Part of next issue: #75 (comment).

[miroslavpojer]

Why the meta data were removed?
Are you presenting the Preview of expected output or raw data?

[MobiTikula]

Since you requested to rollback the changes, I implemented, cause they are not the part of solution for this PR. I do update them back in the next issue: #75 (comment).