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

- adjust README a bit to be more specific

Browse Source
This commit is contained in:
Mike Penz
2021-01-05 18:39:27 +01:00
parent 96cfd6be61
commit 96b4b735ad
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -222,7 +222,7 @@ For advanced use cases additional settings can be provided to the action
### PR Template placeholders ### PR Template placeholders
Table of supported placeholders allowed to be used in the `pr_template` configuration. Table of supported placeholders allowed to be used in the `pr_template` configuration, which will be included in the release notes / changelog.
| **Placeholder** | **Description** | | **Placeholder** | **Description** |
|------------------|-------------------------------------------------------------| |------------------|-------------------------------------------------------------|
@@ -239,7 +239,7 @@ Table of supported placeholders allowed to be used in the `pr_template` configur
### Template placeholders ### Template placeholders
Table of supported placeholders allowed to be used in the `template` and `empty_template` (only supports placeholder marked for empty) configuration. Table of supported placeholders allowed to be used in the `template` and `empty_template` (only supports placeholder marked for empty) configuration, to give additional control on defining the contents of the release notes / changelog.
| **Placeholder** | **Description** | **Empty** | | **Placeholder** | **Description** | **Empty** |
|----------------------------|----------------------------------------------------------------------------------------------------|:---------:| |----------------------------|----------------------------------------------------------------------------------------------------|:---------:|
@@ -257,7 +257,7 @@ Table of supported placeholders allowed to be used in the `template` and `empty_
### Configuration Specification ### Configuration Specification
Table of descriptions for the `configuration.json` options. Table of descriptions for the `configuration.json` options to configure the resulting release notes / changelog.
| **Input** | **Description** | | **Input** | **Description** |
|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -336,7 +336,7 @@ All patches and changes applied to the original source are licensed under the Ap
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
## Sample result changelog ## Sample result release notes / changelog
<div align="center"> <div align="center">
<a href="https://github.com/mikepenz/release-changelog-builder-action/runs/1270879787"><img src=".github/images/release_changelog_builder_expanded.png"/></a> <a href="https://github.com/mikepenz/release-changelog-builder-action/runs/1270879787"><img src=".github/images/release_changelog_builder_expanded.png"/></a>