conventional-pr-title-action

KO | EN

gitlite — search

#javascript #typescript #llm #golang #machine-learning #linux #docker #nodejs #awesome #vue #pytorch #ios #mcp #openai

conventional-pr-title-action

(★ 90)

Ensure your PR title matches the Conventional Commits spec.

conventional-pr-title-action Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Important Notice: This repository has been archived

Please note that no further updates or developments are planned for this repository in the future. The implementation and functionality constraints associated with the `conventional-changelog` packages and the limitations in the data extraction process have led to this decision. For those seeking a maintained and active alternative with mostly similar functionalities, it is recommended to switch to [`amannn/action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request).

Thank you for your support and understanding.

# Conventional PR Title Action

This is a [GitHub Action](https://github.com/features/actions) that ensures your PR title matches the [Conventional Commits spec](https://www.conventionalcommits.org/).

This is helpful when you're using [semantic-release](https://github.com/semantic-release/semantic-release) with the Conventional Commits preset. When using the `Squash and merge` strategy, GitHub will suggest to use the PR title as the commit message. With this action you can validate that the PR title will lead to a correct commit message.

See [Conventional Commits](https://www.conventionalcommits.org/) for sample titles.

## Inputs

### `success-state`

**Optional.** Description of the status check if validation succeeds.
> Default: `"Title follows the specification."`.

### `failure-state`

**Optional.** Description of the status check if validation fails.
> Default: `"Title does not follow the specification."`.

### `context-name`

**Optional.** Persistent status check context key. 
> Default: `"conventional-pr-title"`.

### `preset`

**Optional.** Conventional changelog preset.
> Default: `"conventional-changelog-conventionalcommits@5.0.0"`.

### `target-url`

**Optional.** URL to be used when linking the "Details" in the actions overview.
> Default: `"https://www.conventionalcommits.org/en/v1.0.0/#summary"`.

## Outputs

### `success`

`true` if the validation succeed, `false` otherwise.

### `error`

In case of an error (`success=false`), contains the error message for additional processing or usage in notifications.

## Example usage

```yaml
name: Check PR title

on:
  pull_request_target:
    types:
      - opened
      - reopened
      - edited
      - synchronize

jobs:
  lint:
    runs-on: ubuntu-latest
    permissions:
      statuses: write
    steps:
      - uses: aslafy-z/conventional-pr-title-action@v3
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

> Note: Avoid using `main` ref, prefer to pin to a specific version.

## Credits

All thanks goes to [`amannn`](https://github.com/amannn)'s [`semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request) action.

conventional-pr-title-action

conventional-pr-title-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

conventional-pr-title-action

conventional-pr-title-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README