Skip to content

docs: update readme #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jajera merged 1 commit into from
Apr 26, 2025
Merged

docs: update readme #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,19 @@ A reusable GitHub Action workflow to enforce commit message best practices using
### Basic Usage

```yaml
name: Validate Commit Message
name: Commit Message Conformance

on:
pull_request:
types: [opened, synchronize, reopened]
pull_request: {}

permissions:
statuses: write
checks: write
contents: read
pull-requests: read

jobs:
validate-commit:
commitmsg-conform:
uses: cloudbuildlab/actions-commitmsg-conform/.github/workflows/commitmsg-conform.yml@v1
```

Expand All @@ -38,7 +43,7 @@ jobs:
dco: false
gpg:
required: false
gitHubOrganization: stacksmiths
gitHubOrganization: cloudbuildlab
spellcheck:
locale: US
maximumOfOneCommit: false
Expand Down