enforce-pr-title-style-action

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #llm #go #rust #docker #nodejs #cli #kubernetes #awesome-list #openai

enforce-pr-title-style-action

(★ 9)

No description available.

enforce-pr-title-style-action Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Enforce PR Title Starts With Jira Issue Key

This action analyses the titles of Pull Requests to ensure they start with a Jira Issue Key. Issue Keys are a combination of a Project Key, a hyphen, and a number designating which issue it is. In general, Project Keys are two capital letters but Jira does allow for [custom Project Keys](https://confluence.atlassian.com/adminjiraserver/changing-the-project-key-format-938847081.html) and this issue attempts to abide by the custom format.

For example, if your project key were `AB` then the following would be allowed

```
AB-1  Initialize Project
AB-1: Initialize Project
```

However, the following examples would not be allowed

```
Ab-1 Initialize Project
ab-1 Initialize Project
AB 1 Initialize Project
```

Valid Pull Request titles must also include a short description after the Issue Key. Therefore the following is not valid.

```
AB-1
```

By default, this action will allow any valid Issue Key so long as it *could* be valid. If you want to be specific to your project, use the `project_key` input for the action.

## Inputs

### `project_key`

A specific Project Key to always check for.

## Example Usage

```
- name: Enforce Jira Issue Key in Pull Request Title
  uses: asafHalely/enforce-pr-title-style-action@v1.0
```

## Example Usage with a specific Project Key

```
- name: Enforce PR Title Starts With Jira Issue Key
  uses: asafHalely/enforce-pr-title-style-action@v1.0
  with:
    project_key: AB
```

enforce-pr-title-style-action

enforce-pr-title-style-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

enforce-pr-title-style-action

enforce-pr-title-style-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README