Skip to content

Commit

Permalink
Change: Update README for conventional commits action
Browse files Browse the repository at this point in the history
Use new inputs and explain how the actions works internally now.
  • Loading branch information
bjoernricks committed Jul 7, 2023
1 parent 2529e50 commit 4f796b3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions conventional-commits/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Greenbone Conventional Commits Action

GitHub Action to check for conventional commits
GitHub Action to check for conventional commits. It looks for commits between
a range of git references or git commit IDs. By default it starts looking at the
base commit up to the head commit of a pull request.

## Examples

Expand Down Expand Up @@ -51,5 +53,5 @@ jobs:
| python-version | Python version to use for running the action. | Optional (default is `3.10`) |
| poetry-version | Poetry version to use for running the action. | Optional (default is latest) |
| cache-poetry-installation | Cache poetry and its dependencies. | Optional (default is `"true"`) |
| ref | The branch, tag or SHA to checkout. | Optional. Default of [actions/checkout](https://github.com/actions/checkout). |
| base-ref | Use a specific base ref. | Optional. (default is [`${{ github.base_ref }}`](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context)) |
| head-ref | End ref where to look for conventional commits. | Optional (default is`${{ github.event.pull_request.head.sha }}`). |
| base-ref | Start ref where to look for conventional commits. | Optional (default is `${{ github.event.pull_request.base.sha }}`). |

0 comments on commit 4f796b3

Please sign in to comment.