|
27 | 27 | - [Data Mining from GitHub Projects](#data-mining-from-github-projects)
|
28 | 28 | - [Living Documentation Page Generation](#living-documentation-page-generation)
|
29 | 29 | - [Structured Output](#structured-output)
|
| 30 | + - [Grouped Output by Issue Topics](#grouped-output-by-issue-topics) |
30 | 31 | - [Contribution Guidelines](#contribution-guidelines)
|
31 | 32 | - [License Information](#license-information)
|
32 | 33 | - [Contact or Support Information](#contact-or-support-information)
|
@@ -114,12 +115,15 @@ See the full example of action step definition (in example are used non-default
|
114 | 115 |
|
115 | 116 | # project state mining feature de/activation
|
116 | 117 | project-state-mining: true
|
117 |
| - |
118 |
| - # project verbose (debug) logging feature de/activation |
119 |
| - verbose-logging: true |
120 | 118 |
|
121 | 119 | # structured output feature de/activation
|
122 | 120 | structured-output: true
|
| 121 | + |
| 122 | + # group output by topics feature de/activation |
| 123 | + group-output-by-topics: true |
| 124 | + |
| 125 | + # project verbose (debug) logging feature de/activation |
| 126 | + verbose-logging: true |
123 | 127 | ```
|
124 | 128 |
|
125 | 129 | ## Action Configuration
|
@@ -214,22 +218,31 @@ Configure the action by customizing the following parameters based on your needs
|
214 | 218 | project-state-mining: true
|
215 | 219 | ```
|
216 | 220 |
|
217 |
| -- **verbose-logging** (optional, `default: false`) |
218 |
| - - **Description**: Enables or disables verbose (debug) logging. |
| 221 | +- **structured-output** (optional, `default: false`) |
| 222 | + - **Description**: Enables or disables structured output. |
219 | 223 | - **Usage**: Set to true to activate.
|
220 | 224 | - **Example**:
|
221 | 225 | ```yaml
|
222 | 226 | with:
|
223 |
| - verbose-logging: true |
| 227 | + structured-output: true |
224 | 228 | ```
|
225 |
| - |
226 |
| -- **structured-output** (optional, `default: false`) |
227 |
| - - **Description**: Enables or disables structured output. |
| 229 | + |
| 230 | +- **group-output-by-topics** (optional, `default: false`) |
| 231 | + - **Description**: Enable or disable grouping tickets by topics in the summary index.md file. |
228 | 232 | - **Usage**: Set to true to activate.
|
229 | 233 | - **Example**:
|
230 | 234 | ```yaml
|
231 | 235 | with:
|
232 |
| - structured-output: true |
| 236 | + group-output-by-topics: true |
| 237 | + ``` |
| 238 | + |
| 239 | +- **verbose-logging** (optional, `default: false`) |
| 240 | + - **Description**: Enables or disables verbose (debug) logging. |
| 241 | + - **Usage**: Set to true to activate. |
| 242 | + - **Example**: |
| 243 | + ```yaml |
| 244 | + with: |
| 245 | + verbose-logging: true |
233 | 246 | ```
|
234 | 247 |
|
235 | 248 | ## Action Outputs
|
@@ -394,6 +407,8 @@ export INPUT_REPOSITORIES='[
|
394 | 407 | ]'
|
395 | 408 | export INPUT_OUTPUT_PATH="/output/directory/path
|
396 | 409 | export INPUT_PROJECT_STATE_MINING="true"
|
| 410 | +export INPUT_STRUCTURED_OUTPUT="true" |
| 411 | +export INPUT_GROUP_OUTPUT_BY_TOPICS="true" |
397 | 412 | export INPUT_VERBOSE_LOGGING="true"
|
398 | 413 | ```
|
399 | 414 |
|
@@ -601,13 +616,40 @@ This feature allows you to generate structured output for the living documentati
|
601 | 616 | |-- issue md page 1
|
602 | 617 | |-- issue md page 2
|
603 | 618 | |-- _index.md
|
| 619 | + |-- _index.md |
604 | 620 | |- org 2
|
605 | 621 | |--repo 1
|
606 | 622 | |-- issue md page 1
|
607 | 623 | |-- _index.md
|
608 | 624 | |--repo 2
|
| 625 | + ... |
| 626 | + |-- _index.md |
| 627 | + |- _index.md |
| 628 | + ``` |
| 629 | + |
| 630 | +### Grouped Output by Issue Topics |
| 631 | + |
| 632 | +The feature allows you to generate output grouped by issue topics. This feature is useful when you want to group issues by specific topics or themes. |
| 633 | + |
| 634 | +To gain a better understanding of the term "Topic", refer to the [Labels](#labels) section. |
| 635 | + |
| 636 | +- **Default Behavior**: By default, the action generates all the documentation in a single directory. |
| 637 | +- **Non-default Example**: Use the grouped output feature to organize the generated documentation by issue topics. |
| 638 | + - `group-output-by-topics: true` activates the grouped output feature. |
609 | 639 | ```
|
| 640 | + output |
| 641 | + |- topic 1 |
| 642 | + |-- issue md page 1 |
| 643 | + |-- issue md page 2 |
| 644 | + |-- _index.md |
| 645 | + |- topic 2 |
| 646 | + |-- issue md page 1 |
| 647 | + |-- _index.md |
| 648 | + |- _index.md |
| 649 | + ``` |
| 650 | + |
610 | 651 | ---
|
| 652 | + |
611 | 653 | ## Contribution Guidelines
|
612 | 654 |
|
613 | 655 | We welcome contributions to the Living Documentation Generator! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.
|
|
0 commit comments