Merge pull request #162 from TriPSs/improvements

Improvements

.github/workflows/release.yml

@@ -19,6 +19,7 @@ jobs:
         uses: ./
         with:
           github-token: ${{ secrets.github_token }}
+          create-summary: true
 
       - name: Create Release
         uses: actions/create-release@v1

.gitignore

@@ -3,6 +3,7 @@
 
 # Editors
 .vscode
+.idea
 
 # Logs
 logs

README.md

@@ -24,13 +24,14 @@ This action will bump version, tag commit and generate a changelog with conventi
 - **Optional** `fallback-version`: The fallback version, if no older one can be detected, or if it is the first one. Default `'0.1.0'`
 - **Optional** `config-file-path`: Path to the conventional changelog config file. If set, the preset setting will be ignored
 - **Optional** `pre-changelog-generation`: Path to the pre-changelog-generation script file. No hook by default.
-- **Optional** `skip-ci`: Adds instruction to github to not consider the push something to rebuild. Default `true`.
+- **Optional** `skip-ci`: Adds instruction to Github to not consider the push something to rebuild. Default `true`.
+- **Optional** `create-summary`: Adds the generated changelog as Action Summary. Default `false`.
 
 ### Pre-Commit hook
 
 > Function in a specified file will be run right before the git-add-git-commit phase, when the next
 > version is already known and a new changelog has been generated. You can run any chores across your
-> repository that should be added and commited with the release commit.
+> repository that should be added and committed with the release commit.
 
 Specified path could be relative or absolute. If it is relative, then it will be based on the `GITHUB_WORKSPACE` path.
 

action.yml

@@ -118,6 +118,11 @@ inputs:
     default: 'true'
     required: false
 
+  create-summary:
+    description: 'Adds the generated changelog as Action Summary'
+    default: 'false'
+    required: false
+
 outputs:
   changelog:
     description: 'The generated changelog for the new version'