Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ After the action completes, the `SEMVER_LEVEL` environment variable is set accor

 * `revert` and `WIP` are classified as NONE because the level of semantic versioning change cannot be decided from the commit message alone.

### Token

The commits of a pull request are read through the GitHub API, and the request carries the
token of the workflow by default, so nothing has to be configured:

|Name|Type|Description|
|---|---|---|
|`token`|input|The token used to read the commits of a pull request (default `${{ github.token }}`)|

Setting it to an empty string reads them anonymously, which GitHub limits to 60 requests per
hour per IP address, shared with every other job running on that address, and which cannot
read a private repository at all. The action warns when it does.

### Usage
Latest version: `v1.1.0`

Expand Down
10 changes: 10 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
name: "Flowing Code Commit Message Guidelines"
description: "Ensures that all commit messages are following the Flowing Code Commit Message Guidelines."
inputs:
token:
description: >
The token used to read the commits of a pull request. It defaults to the token of
the workflow, which raises the limit from the 60 requests per hour that GitHub
allows an unauthenticated caller, counted per IP address and therefore shared with
every other job running on the same address. Set it to an empty string to read the
commits anonymously.
required: false
default: ${{ github.token }}
runs:
using: node20
main: dist/main/index.js
Loading