Skip to content

Commit

Permalink
[Internal] PR Lint: Fixes to use new title regex (#1699)
Browse files Browse the repository at this point in the history
* Update PR lint rules

* Set the PR Lint version
  • Loading branch information
j82w authored Jul 14, 2020
1 parent f3bb918 commit ffb7b26
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 38 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/prlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ jobs:
pr-lint:
runs-on: ubuntu-latest
steps:
- uses: morrisoncole/pr-lint-action@master
- uses: morrisoncole/pr-lint-action@v1.1.1
with:
title-regex: '(\[Internal\]|\[v4\] )?.{3}.+: (Add|Fix|Refactor) .{3}.+'
title-regex: '(\[Internal\]|\[v4\] )?.{3}.+: (Adds|Fixes|Refactors) .{3}.+'
on-failed-regex-comment: >
Please follow the required format: \"[Internal] Category: (Add|Fix|Refactor) Description\"<br /><br />
Please follow the required format: \"[Internal] Category: (Adds|Fixes|Refactors) Description\"<br /><br />
Examples:<br />
Diagnostics: Add GetElapsedClientLatency to CosmosDiagnostics<br/>
PartitionKey: Fix null reference when using default(PartitionKey)<br/>
[v4] Client Encryption: Refactor code to external project<br/>
[Internal] Query: Add code generator for CosmosNumbers for easy additions in the future.<br/>
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics<br/>
PartitionKey: Fixes null reference when using default(PartitionKey)<br/>
[v4] Client Encryption: Refactors code to external project<br/>
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.<br/>
repo-token: "${{ secrets.GITHUB_TOKEN }}"
37 changes: 6 additions & 31 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,18 @@
# Pull Request Template

## Pull Request Title
1. Changelog will be generated from PR titles.
2. PR titles will be formatted with the following layout.
1. Internal is optional and represents changes with no public facing changes such as test only changes
2. Category represents the area of the change like batch, changefeed, point operation, or query
3. Add or Fix identifies if a new feature is being added or if a bug is being fixed
4. Description is a user friendly explanation of the change

### Format
`[Internal] Category: (Add|Fix) Description`

### Example
`Diagnostics: Add GetElapsedClientLatency to CosmosDiagnostics`<br/>
`PartitionKey: Fix null reference when using default(PartitionKey)`<br/>
`[Internal] Query: Add code generator for CosmosNumbers for easy additions in the future.`<br/>

## Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Please include a summary of the change and which issue is fixed. Include samples if adding new API, and include relevant motivation and context. List any dependencies that are required for this change.

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
- [] Bug fix (non-breaking change which fixes an issue)
- [] New feature (non-breaking change which adds functionality)
- [] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [] This change requires a documentation update

## Closing issues

Put closes #XXXX in your comment to auto-close the issue that your PR fixes (if such).

## Assignee

Please add yourself as the assignee

## Projects

Please add relevant projects so this issue can be properly tracked.

To automatically close an issue: closes #IssueNumber

0 comments on commit ffb7b26

Please sign in to comment.