diff --git a/.github/images/release_changelog_builder_collapsed.png b/.github/images/release_changelog_builder_collapsed.png new file mode 100644 index 0000000..5faf672 Binary files /dev/null and b/.github/images/release_changelog_builder_collapsed.png differ diff --git a/.github/images/release_changelog_builder_expanded.png b/.github/images/release_changelog_builder_expanded.png new file mode 100644 index 0000000..8d2480d Binary files /dev/null and b/.github/images/release_changelog_builder_expanded.png differ diff --git a/.github/images/release_changelog_result.png b/.github/images/release_changelog_result.png new file mode 100644 index 0000000..8023e4c Binary files /dev/null and b/.github/images/release_changelog_result.png differ diff --git a/README.md b/README.md index d9a7ec6..89caebc 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ ... a GitHub action that builds your release notes fast, easy and exactly the way you want.

+
+ +
+
@@ -21,7 +25,7 @@

What's included 🚀Setup 🛠️ • - Full Sample 🖥️ • + Sample 🖥️Customization 🖍️Contribute 🧬License 📓 @@ -114,6 +118,11 @@ on: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +

+ +
+ +Scroll to the bottom of the README to see a sample result changelog. ## Customization 🖍️ @@ -285,8 +294,9 @@ export GITHUB_TOKEN=your_personal_github_pat ## 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/) +- 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/) +- [action-gh-release](https://github.com/softprops/action-gh-release) for a few great README ideas ## License @@ -310,3 +320,9 @@ All patches and changes applied to the original source are licensed under the Ap WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +## Sample result changelog + +
+ +