-
Notifications
You must be signed in to change notification settings - Fork 0
feat: PR title check action #24
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.
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
+59
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # `pr-title-check` GitHub Action | ||
|
|
||
| This action validates pull request titles by checking them for typos (using [typos](https://github.com/crate-ci/typos)) and verifying they follow the [Conventional Commits](https://www.conventionalcommits.org/) format (using [action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request)). | ||
|
|
||
| The action checks out the repository so that any `_typos.toml` configuration present in the repo is respected. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```yaml | ||
| name: CI (PR) | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: read | ||
|
|
||
| jobs: | ||
| pr-title-check: | ||
| name: PR title check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: apify/actions/pr-title-check@main | ||
| ``` | ||
|
|
||
| ### Inputs | ||
|
|
||
| - `github-token` (optional, default `${{ github.token }}`) — Token used by the semantic PR title check to read PR metadata via the GitHub API. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: "PR title check" | ||
| description: "Check PR title for typos and conventional commit format" | ||
|
|
||
| inputs: | ||
| github-token: | ||
| description: "GitHub token for the semantic PR title check" | ||
| required: false | ||
| default: ${{ github.token }} | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| # Needed to access `_typos.toml` from the repository | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Write PR title to file | ||
| shell: bash | ||
| run: echo "$PR_TITLE" > /tmp/pr-title.txt | ||
| env: | ||
| PR_TITLE: ${{ github.event.pull_request.title }} | ||
|
|
||
| - name: Spell-check PR title | ||
| uses: crate-ci/typos@master | ||
| with: | ||
| files: /tmp/pr-title.txt | ||
|
|
||
| - name: Check PR title follows conventional commits | ||
| uses: amannn/action-semantic-pull-request@v6.1.1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ inputs.github-token }} | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.