Skip to content
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

Modified to support multiple project keys #77

Merged
merged 2 commits into from
Mar 10, 2024
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
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ By default, this action will allow any valid Issue Key so long as it *could* be

A specific Project Key to always check for

### `projectKeys`

Multiple Project Keys to always check for

### `separator`

A specific separator to use. Defaults to a space character.
Expand All @@ -65,6 +69,9 @@ A specific separator to use. Defaults to a space character.

Allows the Jira Project Key, Issue # and separator to be anywhere in the title. Defaults to false.


Note that `projectKey` and `projectKeys` works same under the hood. You can pass either one of them depending on the usecase.

## Example Usage

```
Expand All @@ -81,6 +88,18 @@ Allows the Jira Project Key, Issue # and separator to be anywhere in the title.
projectKey: 'AB'
```

## Example Usage with a multiple Project Keys

```
- name: Enforce Jira Issue Key in Pull Request Title
uses: ryanvade/enforce-pr-title-style-action@v2
with:
projectKeys: |
'AB'
'CD'
'EF'
```

## Example Usage with a specific Project Key and a separator

```
Expand Down
Loading
Loading