Skip to content

Commit

Permalink
📝 Adjusted Typos in Readme + reduced description length of action.yml (
Browse files Browse the repository at this point in the history
…#10)

* Update action.yml

* Update README.md
  • Loading branch information
Templum authored May 2, 2024
1 parent 00fb99c commit 01d6de2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This action generates a `CHANGELOG` based on the git history using the [Gitmoji]
| ----------------------- | -------- | ------- | ----------------------------------------------------------- |
| add-authors | false | 'true' | This determines whether the Authors of the Commits should be added to the changelog. It should be a valid YAML boolean value (e.g. TRUE, FALSE, true, false). |
| override-project-path | false | '' | This can be used to provide a relative path to the project root that should be used to collect history. Should not start with ".". |
| override-changelog-path | false | '' | This can be used to provide a relative path to the project root that should be useda to store the CHANGELOG. Should end on "CHANGELOG.md" and not start wtih ".". |
| override-changelog-path | false | '' | This can be used to provide a relative path to the project root where the CHANGELOG should be stored. It should end on "CHANGELOG.md" and not start with ".". |

## Outputs

Expand Down Expand Up @@ -49,4 +49,4 @@ jobs:
title: ":memo: Update Changelog for ${{ steps.outputs.for-version }}"
commit-message: ":memo: Update Changelog for ${{ steps.outputs.for-version }}"
```
</details>
</details>
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'Gitmoji Changelog'
description: 'Generates and updates Changelog based on git commits following Gitmoji Convention. Only does support Javascript/Node projects at the moment'
description: 'Maintains a Changelog based on Commits in Gitmoji Convention. At the moment JS supported.'
author: 'Templum'

runs:
Expand All @@ -15,7 +15,7 @@ inputs:
description: 'This can be used to provide a relative path to the project root that should be used to collect history. Should not start with ".".'
override-changelog-path:
default: ''
description: 'This can be used to provide a relative path to the project root that should be useda to store the CHANGELOG. Should end on "CHANGELOG.md" and not start wtih ".".'
description: 'This can be used to provide a relative path to the project root where the CHANGELOG should be stored. It should end on "CHANGELOG.md" and not start with ".".
outputs:
for-version:
Expand All @@ -25,4 +25,4 @@ outputs:

branding:
icon: 'edit'
color: 'blue'
color: 'blue'

0 comments on commit 01d6de2

Please sign in to comment.