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

- add optional key to README

Browse Source
This commit is contained in:
Mike Penz
2023-05-25 18:09:38 +00:00
committed by GitHub
parent 5d46efec54
commit 61be84a086
2 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -211,6 +211,7 @@ This configuration is a `JSON` in the following format. (The below showcases *ex
"labels": ["fix"]
},
{
"key": "tests",
"title": "## 🧪 Tests",
"labels": ["test"]
},
@@ -419,6 +420,7 @@ Table of descriptions for the `configuration.json` options to configure the resu
| **Input** | **Description** |
|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| categories | An array of `category` specifications, offering a flexible way to group changes into categories. |
| category.key | Optional key used for the `categorized` json output. |
| category.title | The display name of a category in the changelog. |
| category.labels | An array of labels, to match pull request labels against. If any PR label matches any category label, the pull request will show up under this category. (See `exhaustive` to change this) |
| category.exclude_labels | Similar to `labels`, an array of labels to match PRs against, but if a match occurs the PR is excluded from this category. |
configs/configuration.json
-3
View File
@@ -1,17 +1,14 @@
{
"categories": [
{
"key": "feature",
"title": "## 🚀 Features",
"labels": ["feature"]
},
{
"key": "fixes",
"title": "## 🐛 Fixes",
"labels": ["fix"]
},
{
"key": "tests",
"title": "## 🧪 Tests",
"labels": ["test"]
}