breaking: it is alive!

Author: tomasbjerre

.github/workflows/draft-release.yaml

@@ -0,0 +1,20 @@
+name: Git Changelog Github Release
+
+on: [workflow_dispatch, workflow_call, push]
+
+jobs:
+  build:
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-tags: 'true'
+          fetch-depth: '0'
+      - name: Setup java
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'zulu'
+          java-version: 17
+      - uses: tomasbjerre/git-changelog-github-release@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -2,7 +2,40 @@
 
 This is a
 [GitHub action](https://docs.github.com/en/actions/creating-actions/about-custom-actions)
-that can:
+that can draft release in GitHub generated from template using
+[git-changelog-lib](https://github.com/tomasbjerre/git-changelog-lib).
 
-- Draft release in GitHub generated from template using
-  [git-changelog-lib](https://github.com/tomasbjerre/git-changelog-lib).
+- You can have it running on your **default branch**, not depending on
+  pull-requests.
+- Uses **conventional commits** to keep a **draft release** updated and ready to
+  be published.
+  - It will parse any commit in branch and construct the **draft description**
+    from that.
+  - It will **adjust the draft version** based on conventional commits.
+
+## Usage
+
+- Create a file, perhaps `.github/workflows/draft-release.yaml`, with content:
+
+```yaml
+name: Git Changelog Github Release
+
+on: [workflow_dispatch, workflow_call, push]
+
+jobs:
+  build:
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-tags: 'true'
+          fetch-depth: '0'
+      - name: Setup java
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'zulu'
+          java-version: 17
+      - uses: tomasbjerre/git-changelog-github-release@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needs write permission in Github menu '/settings/actions'
+```

action.yml

@@ -8,14 +8,19 @@ branding:
   color: white
   icon: archive
 inputs:
+  draft:
+    required: true
+    description: 'If it should be a draft in GitHub or an actual release'
+    default: 'true'
   template:
     description: |
       Rendered and used as description. See https://github.com/tomasbjerre/git-changelog-lib for documentation.
     required: false
     default: |
-      {{#with tags.[0]}}
+      {{#tags}}
+      {{#ifEquals name "Unreleased"}}
       {{#ifContainsBreaking commits}}
-      #💣 Breaking changes
+      # 💣 Breaking changes
 
       {{#commits}}
       {{#ifCommitBreaking .}}
@@ -25,7 +30,7 @@ inputs:
 
       {{/ifContainsBreaking}}
       {{#ifContainsType commits type='feat'}}
-      #🚀 Features
+      # 🚀 Features
 
       {{#commits}}
       {{#ifCommitType . type='feat'}}
@@ -35,7 +40,7 @@ inputs:
 
       {{/ifContainsType}}
       {{#ifContainsType commits type='fix'}}
-      #🐛 Bug Fixes
+      # 🐛 Bug Fixes
 
       {{#commits}}
       {{#ifCommitType . type='fix'}}
@@ -45,7 +50,7 @@ inputs:
 
       {{/ifContainsType}}
       {{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
-      #🧰 Other changes
+      # 🧰 Other changes
 
       {{#commits}}
       {{#ifCommitType . type='^$'}}
@@ -61,4 +66,16 @@ inputs:
       {{/commits}}
 
       {{/ifContainsType}}
-      {{/with}}
+      {{/ifEquals}}
+      {{/tags}}
+outputs:
+  id:
+    description: Of created release
+  html_url:
+    description: Of created release
+  upload_url:
+    description: Of created release
+  version:
+    description: Of created release
+  description:
+    description: That was reated