From d970a0bc9a36ba9216ab8c76181adbfa707515e9 Mon Sep 17 00:00:00 2001
From: Mike Penz <mikepenz@gmail.com>
Date: Sat, 17 Oct 2020 20:13:31 +0200
Subject: [PATCH] - improve messages for test output - include complete sample
 in README

---
 .github/workflows/ci.yml |  9 +++++++--
 README.md                | 42 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index a5d49d0..3f5f5f0 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -22,13 +22,18 @@ jobs:
     if: github.event_name  == 'pull_request'
     runs-on: ubuntu-latest
     steps:
+      # Won't support providing a configuration file, as no checkout was done
       - name: "Configuration without Checkout"
+        id: without_checkout
         uses: mikepenz/release-changelog-builder-action@develop
         with:
           toTag: "v0.0.3"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       
+      - name: Echo Configuration without Checkout Changelog
+        run: echo "${{steps.without_checkout.outputs.changelog}}"
+
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0 # Checkout full depth so tags can be discovered automatically if not specified
@@ -39,7 +44,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       
-      - name: Echo Minimal
+      - name: Echo Minimal Configuration Changelog
         run: echo "${{steps.minimal_release.outputs.changelog}}"
 
       - name: "Complex Configuration"
@@ -53,7 +58,7 @@ jobs:
           toTag: "v0.0.3"
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Echo Complex
+      - name: Echo Complex Configuration Changelog
         run: echo "${{steps.complex_release.outputs.changelog}}"
 
   release:
diff --git a/README.md b/README.md
index 92df9de..665ea75 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@
     <a href="#setup">Setup 🛠️</a> &bull;
     <a href="#customization-%EF%B8%8F">Customization 🖍️</a> &bull;
     <a href="#contribute-">Contribute 🧬</a> &bull;
+    <a href="#complete-sample-">Complete Sample 🖥️</a> &bull;
     <a href="#license">License 📓</a>
 </p>
 
@@ -171,6 +172,47 @@ Table of supported placeholders allowed to be used in the `pr_template` configur
 | `${{UNCATEGORIZED}}` | All pull requests not matching a specified label in categories                                  |
 
 
+## Complete Sample 🖥️
+
+Below is a complete example showcasing how to define a build, which is executed when tagging the project. It consists of:
+- Prepare tag, via the GITHUB_REF environment variable
+- Build changelog, given the tag
+- Create release on GitHub - specifying body with constructed changelog
+ 
+```yml
+name: 'CI'
+on:
+  push:
+    tags:
+      - '*'
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Retrieve tag
+        if: startsWith(github.ref, 'refs/tags/')
+        id: tag_version
+        run: echo ::set-output name=VERSION::$(echo ${GITHUB_REF:10})
+
+      - name: Build Changelog
+        id: github_release
+        uses: mikepenz/release-changelog-builder-action@main
+        with:
+          toTag: ${{ steps.tag_version.outputs.VERSION }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create Release
+        uses: actions/create-release@v1
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: ${{steps.github_release.outputs.changelog}}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
 ## Contribute 🧬
 
 ```bash