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.

Sign up for GitHub

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

[Internal] PR Requirements: Add PR title requirements to allow changelog generation #1322

Merged
merged 15 commits into from
Apr 3, 2020
Merged

[Internal] PR Requirements: Add PR title requirements to allow changelog generation #1322

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
011ddef
Updating PR template with PR title as changelog
j82w Mar 30, 2020
493c78a
Updated based on feedback
j82w Apr 1, 2020
1a5f2cc
Fixed grammar
j82w Apr 1, 2020
643dd97
More fixes
j82w Apr 1, 2020
10d5a4c
Adding pr lint action
Apr 1, 2020
52474af
Try single quotes to fix parse error
Apr 1, 2020
3a201d3
Trying to move it to build yaml
Apr 1, 2020
266e405
Try including all changes
Apr 1, 2020
57465c9
Updating
Apr 1, 2020
5239ea0
Reverting changes
Apr 1, 2020
80f7766
updated based on feedback
j82w Apr 2, 2020
1800df0
updating regex
j82w Apr 2, 2020
0022da4
Removing space
j82w Apr 2, 2020
e58f3ab
Updated based on user suggestion
Apr 3, 2020
22c0edb
Merge to latest
Apr 3, 2020
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
15 changes: 15 additions & 0 deletions .github/workflows/prlint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: PR Lint

on:
pull_request:
types: [opened, edited, reopened]

jobs:
pr-lint:
runs-on: ubuntu-latest
steps:
- uses: morrisoncole/pr-lint-action@v1.0.0
with:
title-regex: '(\[Internal\])? (Added|Fixed) .{3}.+: .{3}.+'
on-failed-regex-comment: "Please follow the required format. [Internal] (Added|Fixed) Category: Description"
repo-token: "${{ secrets.GITHUB_TOKEN }}"
16 changes: 16 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# 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. Added or Fixed 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](Added/Fixed)(Category):(Description)`

### Example
Added Diagnostics: GetElapsedClientLatency to CosmosDiagnostics
Fixed PartitionKey: null reference when using default(PartitionKey)
[Internal] Added Query: code generator for CosmosNumbers for easy additions in the future.

## 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.
Expand Down