From 4ee65b5cf02ccbac40a99236c012d01c46243965 Mon Sep 17 00:00:00 2001 From: Mike Penz Date: Sat, 17 Oct 2020 10:35:05 +0200 Subject: [PATCH 1/2] - update readme, with more details, more emojis, more everything --- README.md | 98 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 70 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index b1c1ab7..89c97ca 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,49 @@ +
+ :octocat: +
+

+ release-changelog-builder-action +

-# release-changelog-builder-action +

+ ... a github action that builds your release notes, fast, easy and exactly the way you want. +

-Builds the release notes between two tags (or refs) from pull requests merged. +
+ + + +
+
-## Action usage +------- -Include this action in your build by defining the action in your workflow: +

+ What's included 🚀 • + Setup 🛠️ • + Customization 🖍️ • + Contribute 🧬 • + License 📓 • +

+ +------- + +### What's included 🚀 + +- Super simple integration + - even on huge repositories with hundreds of tags +- Parallel releases support +- Blazing fast execution +- Suports any git project +- Highly flexible configuration +- Lightweight +- Supports any branch + +# Setup + +## Configure the workflow + +Specify the action as part of your GitHub actions workflow: ```yml - name: "Build Changelog" @@ -16,17 +54,20 @@ Include this action in your build by defining the action in your workflow: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` -This will automatically pull the tag from the current commit (the latest tag), and try to resolve the tag before this. +By default the action will try to automatically retrieve the `tag` from the current commit, and automtacally resolve the `tag` before. Read more about this here. ## Action outputs -The result of this action is returned via the outputs, and can be retrieved via the `changelog` value in the step afterwards. See the `test.yml` for a sample. +The action will succeed and return the `changelog` as a step output. Use it in any follow up step, by referencing via its id. For example `build_changelog`. ```yml +# ${{steps.{CHANGELOG_STEP_ID}.outputs.changelog}} ${{steps.build_changelog.outputs.changelog}} ``` -## Configuration +# Customization 🖍️ + +## Changelog Configuration By default the action will look for a file called `configuration.json` within the root of the repository to load the config from. If this file does not exist, defaults are used. @@ -37,10 +78,6 @@ By default the action will look for a file called `configuration.json` within th "title": "## 🚀 Features", "labels": ["feature"] }, - { - "title": "## 🦄 Internal Features", - "labels": ["internal"] - }, { "title": "## 🐛 Fixes", "labels": ["fix"] @@ -86,32 +123,38 @@ For advanced usecases additional settings can be provided to the action configuration: "configuration_complex.json" owner: "mikepenz" repo: "release-changelog-builder-action" - ignorePreReleases: "false" # allows to skip any pre releases, if `fromTag` needs to be automatically resolved (ignores 0.0.2-rc02 for example) - only relevant if `fromTag` is not provided + ignorePreReleases: "false" fromTag: "0.0.2" toTag: "0.0.3" - token: ${{ secrets.GITHUB_TOKEN }} # the token to use, for a different repository a PAT is required (Personal access token) + token: ${{ secrets.PAT }} ``` +💡 `ignorePreReleases` will be ignored, if `fromTag` is specified. `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repos please use a PAT. + ## PR Template placeholders -| Variable | Description | -| --------- | -------------------------- | -| `${{NUMBER}}` | Pull request number | -| `${{TITLE}}` | The title of the pull request | -| `${{URL}}` | The URL linking to the pull request | -| `${{MERGED_AT}}` | The time this PR was merged | -| `${{AUTHOR}}` | The author of the pull request | -| `${{BODY}}` | The body / description of the pull request | +Table of supported placeholders allowed to be used in the `template` configuration. -## Template placeholdrs +| **Placeholder** | **Description** | +|------------------|-------------------------------------------------------------| +| `${{NUMBER}}` | The number referencing this pull request. E.g. 13 | +| `${{TITLE}}` | Specified title of the merged pull request | +| `${{URL}}` | Url linking to the pull request on GitHub | +| `${{MERGED_AT}}` | The ISO time, the pull request was merged at | +| `${{AUTHOR}}` | Author creating and opening the pull request | +| `${{BODY}}` | Description/Body of the pull request as specified on GitHub | -| Variable | Description | -| --------- | -------------------------- | -| `${{CHANGELOG}}` | The contents of the main changelog, matching the labels as specified in the categories configuration | -| `${{UNCATEGORIZED}}` | All pull requests not matching a label | +## Template placeholders + +Table of supported placeholders allowed to be used in the `pr_template` configuration. + +| **Placeholder** | **Description** | +|----------------------|-------------------------------------------------------------------------------------------------| +| `${{CHANGELOG}}` | The contents of the changelog, matching the labels as specified in the categories configuration | +| `${{UNCATEGORIZED}}` | All pull requests not matching a specified label in categories | -# Contribute +# Contribute 🧬 ```bash # Install the dependencies @@ -133,7 +176,6 @@ It's suggested to export the token to your path, before running the tests, so AP export GITHUB_TOKEN=your_personal_github_pat ``` - # Developed By * Mike Penz From 876d5042a33329ef419db306a8b8e814f4464167 Mon Sep 17 00:00:00 2001 From: Mike Penz Date: Sat, 17 Oct 2020 10:38:40 +0200 Subject: [PATCH 2/2] - change header sizes --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 89c97ca..7df6b18 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@

What's included 🚀 • Setup 🛠️ • - Customization 🖍️ • + Customization 🖍️ • Contribute 🧬 • License 📓 •

@@ -39,9 +39,11 @@ - Lightweight - Supports any branch -# Setup +------- -## Configure the workflow +## Setup + +### Configure the workflow Specify the action as part of your GitHub actions workflow: @@ -56,7 +58,7 @@ Specify the action as part of your GitHub actions workflow: By default the action will try to automatically retrieve the `tag` from the current commit, and automtacally resolve the `tag` before. Read more about this here. -## Action outputs +### Action outputs The action will succeed and return the `changelog` as a step output. Use it in any follow up step, by referencing via its id. For example `build_changelog`. @@ -65,9 +67,9 @@ The action will succeed and return the `changelog` as a step output. Use it in a ${{steps.build_changelog.outputs.changelog}} ``` -# Customization 🖍️ +## Customization 🖍️ -## Changelog Configuration +### Changelog Configuration By default the action will look for a file called `configuration.json` within the root of the repository to load the config from. If this file does not exist, defaults are used. @@ -110,7 +112,7 @@ Any section of the configruation can be ommited, to have defaults apply Defaults for the configuraiton can be found in the [configuration.ts](https://github.com/mikepenz/release-changelog-builder-action/blob/develop/src/configuration.ts) -## Advanced workflow specification +### Advanced workflow specification For advanced usecases additional settings can be provided to the action @@ -131,7 +133,7 @@ For advanced usecases additional settings can be provided to the action 💡 `ignorePreReleases` will be ignored, if `fromTag` is specified. `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repos please use a PAT. -## PR Template placeholders +### PR Template placeholders Table of supported placeholders allowed to be used in the `template` configuration. @@ -144,7 +146,7 @@ Table of supported placeholders allowed to be used in the `template` configurati | `${{AUTHOR}}` | Author creating and opening the pull request | | `${{BODY}}` | Description/Body of the pull request as specified on GitHub | -## Template placeholders +### Template placeholders Table of supported placeholders allowed to be used in the `pr_template` configuration. @@ -154,7 +156,7 @@ Table of supported placeholders allowed to be used in the `pr_template` configur | `${{UNCATEGORIZED}}` | All pull requests not matching a specified label in categories | -# Contribute 🧬 +## Contribute 🧬 ```bash # Install the dependencies @@ -176,22 +178,22 @@ It's suggested to export the token to your path, before running the tests, so AP export GITHUB_TOKEN=your_personal_github_pat ``` -# Developed By +## Developed By * Mike Penz * [mikepenz.com](http://mikepenz.com) - * [paypal.me/mikepenz](http://paypal.me/mikepenz) -# Credits +## Credits Core parts of the PR fetching logic, are based on [pull-release-notes](https://github.com/nblagoev/pull-release-notes) - Nikolay Blagoev - [GitHub](https://github.com/nblagoev/) -# License +## License Copyright for portions of pr-release-notes are held by Nikolay Blagoev, 2019-2020 as part of project pull-release-notes. All other copyright for project pr-release-notes are held by Mike Penz, 2020. -# Fork License +## Fork License All patches and changes applied to the original source are licensed under the Apache 2.0 license.