Skip to content

Commit

Permalink
Updated README file
Browse files Browse the repository at this point in the history
  • Loading branch information
ddevassy committed Apr 13, 2020
1 parent 1d88aec commit 506a997
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

A GitHub Action that verifies your pull request contains a reference to a ticket. You can use this to (optionally) check:

* The PR title contains `[PROJ-1234]`
* The branch name contains `PROJ-1234` or `PROJ_1234`
* Each commit contains `[PROJ-1234]`
* The PR title contains `[VC-1234]`
* The branch name contains `VC-1234` or `VC_1234`
* Each commit contains `[VC-1234]`



## Usage

Add `.github/workflows/main.yml` with the following:
Add `.github/workflows/jiracheck.yml` with the following:

```
name: PR Lint
Expand All @@ -19,20 +19,20 @@ jobs:
pr_lint:
runs-on: ubuntu-latest
steps:
- uses: vijaykramesh/pr-lint-action@v1.0
- uses: Logitech/vc-pr-jira-action@v1.2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

## Configuration

Configure by creating a `.github/pr-lint.yml` file:
Configure by creating a `.github/jira_config.yml` file:

For example:

```yml
projects: ['PROJ', 'ABC']
tickets: ['VC', 'JIRA']
check_title: true
check_branch: true
check_commits: true
Expand All @@ -41,7 +41,7 @@ ignore_case: true
## Testing
Run `jest test` to test:
Run `jest test` or `npm test` to test:

```
PASS ./index.test.js
Expand Down

0 comments on commit 506a997

Please sign in to comment.