Feature/57 prepare action inputs for several regimes #72
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,21 +43,26 @@ See the default minimal Living Documentation regime action step definition: | |
| GITHUB-TOKEN: ${{ secrets.REPOSITORIES_ACCESS_TOKEN }} | ||
| with: | ||
| liv-doc-regime: true # living documentation regime de/activation | ||
| liv-doc-repositories: '[ | ||
| { | ||
| "organization-name": "fin-services", | ||
| "repository-name": "investment-app", | ||
| "query-labels": ["feature", "enhancement"], | ||
| "projects-title-filter": [] | ||
| }, | ||
| { | ||
| "organization-name": "health-analytics", | ||
| "repository-name": "patient-data-analysis", | ||
| "query-labels": ["functionality"], | ||
| "projects-title-filter": ["Health Data Analysis Project"] | ||
| }, | ||
| { | ||
| "organization-name": "open-source-initiative", | ||
| "repository-name": "community-driven-project", | ||
| "query-labels": ["improvement"], | ||
| "projects-title-filter": ["Community Outreach Initiatives", "CDD Project"] | ||
| } | ||
| ]' | ||
| ``` | ||
|
|
||
| See the full example of Living Documentation regime step definition (in example are used non-default values): | ||
|
|
@@ -72,21 +77,26 @@ See the full example of Living Documentation regime step definition (in example | |
| liv-doc-regime: true # living documentation regime de/activation | ||
| verbose-logging: true # project verbose (debug) logging feature de/activation | ||
|
|
||
| liv-doc-repositories: '[ | ||
| { | ||
| "organization-name": "fin-services", | ||
| "repository-name": "investment-app", | ||
| "query-labels": ["feature", "enhancement"], | ||
| "projects-title-filter": [] | ||
| }, | ||
| { | ||
| "organization-name": "health-analytics", | ||
| "repository-name": "patient-data-analysis", | ||
| "query-labels": ["functionality"], | ||
| "projects-title-filter": ["Health Data Analysis Project"] | ||
| }, | ||
| { | ||
| "organization-name": "open-source-initiative", | ||
| "repository-name": "community-driven-project", | ||
| "query-labels": ["improvement"], | ||
| "projects-title-filter": ["Community Outreach Initiatives", "CDD Project"] | ||
| } | ||
| ]' | ||
| liv-doc-project-state-mining: true # project state mining feature de/activation | ||
| liv-doc-structured-output: true # structured output feature de/activation | ||
| liv-doc-group-output-by-topics: true # group output by topics feature de/activation | ||
|
|
@@ -104,21 +114,26 @@ Configure the Living Documentation regime by customizing the following parameter | |
| - **Example**: | ||
| ```yaml | ||
| with: | ||
| liv-doc-repositories: '[ | ||
| { | ||
| "organization-name": "fin-services", | ||
| "repository-name": "investment-app", | ||
| "query-labels": ["feature", "enhancement"], | ||
| "projects-title-filter": [] | ||
| }, | ||
| { | ||
| "organization-name": "health-analytics", | ||
| "repository-name": "patient-data-analysis", | ||
| "query-labels": ["functionality"], | ||
| "projects-title-filter": ["Health Data Analysis Project"] | ||
| }, | ||
| { | ||
| "organization-name": "open-source-initiative", | ||
| "repository-name": "community-driven-project", | ||
| "query-labels": ["improvement"], | ||
| "projects-title-filter": ["Community Outreach Initiatives", "CDD Project"] | ||
| } | ||
| ]' | ||
| ``` | ||
|
|
||
| - **liv-doc-project-state-mining** (optional, `default: false`) | ||
miroslavpojer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
@@ -159,33 +174,19 @@ The Living Documentation Generator in Living Documentation regime is designed to | |
| ### Index Page Example | ||
|
|
||
| ```markdown | ||
| # Issue Summary page | ||
|
There was a problem hiding this comment. Why the meta data were removed? There was a problem hiding this comment. 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). |
||
|
|
||
| Our project is designed with a myriad of issues to ensure seamless user experience, top-tier functionality, and efficient operations. | ||
| Here, you'll find a summarized list of all these issues, their brief descriptions, and links to their detailed documentation. | ||
|
|
||
| ## Issue Overview | ||
|
|
||
| | Organization name| Repository name | Issue 'Number - Title' | Linked to project | Project Status | Issue URL | | ||
| |------------------|----------------------------|--------------------------------|-------------------|----------------|------------| | ||
| | AbsaOSS | living-doc-example-project | [#89 - Test issue 2](89_test_issue_2.md) | 🔴 | --- |[GitHub](#) | | ||
| | AbsaOSS | living-doc-example-project | [#88 - Test issue](88_test_issue.md) | 🟢 | Todo |[GitHub](#) | | ||
| | AbsaOSS | living-doc-example-project | [#41 - Initial commit.](41_initial_commit.md) | 🟢 | Done |[GitHub](#) | | ||
| | AbsaOSS | living-doc-example-project | [#33 - Example bugfix](33_example_bugfix.md) | 🔴 | --- |[GitHub](#) | | ||
| ``` | ||
|
|
||
| - **Project Status** can have various values depending on the project, such as: Todo, Done, Closed, In Progress, In Review, Blocked, etc. | ||
|
|
@@ -195,12 +196,7 @@ These values can vary from project to project. | |
| ### Issue Page Example | ||
|
|
||
| ```markdown | ||
| # FEAT: Advanced Book Search | ||
| | Attribute | Content | | ||
| |-------------------|---------------------------------------| | ||
| | Organization name | AbsaOSS | | ||
|
|
@@ -216,11 +212,12 @@ weight: 1 | |
| | Status | Todo | | ||
| | Priority | P1 | | ||
| | Size | S | | ||
| | MoSCoW | N/A | | ||
|
|
||
| ## Issue Content | ||
| Users often struggle to find specific books in a large catalog. An advanced search feature would streamline this process, enhancing user experience. | ||
|
|
||
| ### Background | ||
| ... | ||
| ``` | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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.
Part of next issue: #75 (comment).