mikepenz/release-changelog-builder-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- introduce output with the categorised count of prs

Browse Source 
- FIX https://github.com/mikepenz/release-changelog-builder-action/issues/658
This commit is contained in:
Mike Penz
2022-02-01 17:52:51 +01:00
parent 8151a3f1e0
commit c1f978e272
4 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -9
View File
@@ -74,15 +74,17 @@ ${{steps.build_changelog.outputs.changelog}}
A full set list of possible output values for this action.
| **Output** | **Description** |
|---------------------|---------------------------------------------------------------------------------------------------------------------------|
| `outputs.changelog` | The built release changelog built from the merged pull requests |
| `outputs.owner` | Specifies the owner of the repository processed |
| `outputs.repo` | Describes the repository name, which was processed |
| `outputs.fromTag` | Defines the `fromTag` which describes the lower bound to process pull requests for |
| `outputs.toTag` | Defines the `toTag` which describes the upper bound to process pull request for |
| `outputs.failed` | Defines if there was an issue with the action run, and the changelog may not have been generated correctly. [true, false] |
| `outputs.pull_requests` | Defines a `,` joined array with all PR IDs associated with the generated changelog. |
| **Output** | **Description** |
|-----------------------|---------------------------------------------------------------------------------------------------------------------------|
| `outputs.changelog` | The built release changelog built from the merged pull requests |
| `outputs.owner` | Specifies the owner of the repository processed |
| `outputs.repo` | Describes the repository name, which was processed |
| `outputs.fromTag` | Defines the `fromTag` which describes the lower bound to process pull requests for |
| `outputs.toTag` | Defines the `toTag` which describes the upper bound to process pull request for |
| `outputs.failed` | Defines if there was an issue with the action run, and the changelog may not have been generated correctly. [true, false] |
| `outputs.pull_requests` | Defines a `,` joined array with all PR IDs associated with the generated changelog. |
| `outputs.categorized_prs` | Count of PRs which were successfully categorized as part of the action. |
| `outputs.uncategorized_prs` | Count of PRs which were not categorized as part of the action. |
## Full Sample 🖥️
dist/index.js
Generated Vendored
+2
View File
@@ -1311,11 +1311,13 @@ function buildChangelog(prs, options) {
}
}
core.info(`✒️ Wrote ${categorizedPrs.length} categorized pull requests down`);
core.setOutput('categorized_prs', categorizedPrs.length);
let changelogUncategorized = '';
for (const pr of uncategorizedPrs) {
changelogUncategorized = `${changelogUncategorized + pr}\n`;
}
core.info(`✒️ Wrote ${uncategorizedPrs.length} non categorized pull requests down`);
core.setOutput('uncategorized_prs', uncategorizedPrs.length);
let changelogIgnored = '';
for (const pr of ignoredPrs) {
changelogIgnored = `${changelogIgnored + pr}\n`;
dist/index.js.map
Generated Vendored
+1 -1
View File
File diff suppressed because one or more lines are too long
src/transform.ts
+2
View File
@@ -165,6 +165,7 @@ export function buildChangelog(
}
}
core.info(`✒️ Wrote ${categorizedPrs.length} categorized pull requests down`)
core.setOutput('categorized_prs', categorizedPrs.length)
let changelogUncategorized = ''
for (const pr of uncategorizedPrs) {
@@ -173,6 +174,7 @@ export function buildChangelog(
core.info(
`✒️ Wrote ${uncategorizedPrs.length} non categorized pull requests down`
)
core.setOutput('uncategorized_prs', uncategorizedPrs.length)
let changelogIgnored = ''
for (const pr of ignoredPrs) {