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

Update pr template and re-add Changelog builder #3575

Merged
merged 12 commits into from
Feb 1, 2022
28 changes: 21 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
# What does this PR do?
**Collection**: [Note which collection this PR will affect]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we still need a header here, or people are going to miss filling out the collection.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah good point.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a header.


Please have one of the following:
# Changelog
- Add specific line by line info of high level changes in this PR.

* Fixes # (issue)
* New feature: (short feature description)
# Usage
* You can potentially add a usage example below

## Before your PR is "Ready for review"
```python
# Add a code snippet demonstrating how to use this
```

# Before your PR is "Ready for review"
**Pre checks**:
- [ ] Make sure you read and followed [Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md)
- [ ] Did you write any new necessary tests?
- [ ] Did you add or updated any necessary documentation?

- [ ] Did you add or update any necessary documentation?
- [ ] Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
- [ ] Reviewer: Does the PR have correct import guards for all optional libraries?

**PR Type**:
- [ ] Bugfix
- [ ] Documentation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add - [ ] New Feature or something like that?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New feature is the default and would almost always be selected though ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added it.


If you haven't finished some of the above items you can still open "Draft" PR.

Expand All @@ -18,3 +29,6 @@ If you haven't finished some of the above items you can still open "Draft" PR.

Anyone in the community is free to review the PR once the checks have passed.
[Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md) contains specific people who can review PRs to various areas.

# Additional Information
* Related to # (issue)
4 changes: 2 additions & 2 deletions .github/workflows/changelog-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
if: startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.4.0
- uses: actions/checkout@v2
with:
fetch-depth: 0 # Required due to the way Git works, without it this action won't be able to find any or the correct tags

Expand All @@ -25,7 +25,7 @@ jobs:

- name: Build Changelog
id: github_tag
uses: mikepenz/release-changelog-builder-action@v2.7.2
uses: mikepenz/release-changelog-builder-action@v2.8.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
Expand Down
86 changes: 16 additions & 70 deletions .github/workflows/config/changelog-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,116 +38,62 @@
],
"sort": "ASC",
"template": "${{CHANGELOG}}\nUncategorized:\n${{UNCATEGORIZED}}\n\n",
"pr_template": "- ${{TITLE}} :: PR: #${{NUMBER}}",
"pr_template": "- ${{TITLE}} by @${{AUTHOR}} :: PR: #${{NUMBER}}",
"empty_template": "${{OWNER}}\n${{REPO}}\n${{FROM_TAG}}\n${{TO_TAG}}",
"label_extractor": [
{
"pattern": "(.*tts.*)|(.*g2p.*)",
"target": "tts",
"flags": "gimu",
"on_property": "title"
"on_property": ["title", "body"]
},
{
"pattern": "(.*tts.*)|(.*g2p.*)",
"target": "tts",
"flags": "gimu",
"on_property": "body"
},
{
"pattern": "(.*asr.*)|(.*ctc.*)|(.*rnnt.*)|(.*transducer.*)|(.*dali.*)",
"pattern": "(.*asr.*)|(.*ctc.*)|(.*rnnt.*)|(.*transducer.*)|(.*dali.*)|(.*k2.*)",
"target": "asr",
"flags": "gimu",
"on_property": "title"
},
{
"pattern": "(.*asr.*)|(.*ctc.*)|(.*rnnt.*)|(.*transducer.*)|(.*dali.*)",
"target": "asr",
"flags": "gimu",
"on_property": "body"
},
{
"pattern": "(.*nlp.*)|(.*punctuation.*)|(.*capitalization.*)|(.*entity.*)|(.*glue.*)|(.*entity.*)|(.*retrieval.*)|(.*entity.*)|(.*intent.*)|(.*slot.*)|(.*entity.*)|(.*language.*)|(.*qa.*)|(.*token class.*)|(.*text class.*)",
"target": "nlp",
"flags": "gimu",
"on_property": "title"
"on_property": ["title", "body"]
},
{
"pattern": "(.*nlp.*)|(.*punctuation.*)|(.*capitalization.*)|(.*entity.*)|(.*glue.*)|(.*entity.*)|(.*retrieval.*)|(.*entity.*)|(.*intent.*)|(.*slot.*)|(.*entity.*)|(.*language.*)|(.*qa.*)|(.*token class.*)|(.*text class.*)",
"target": "nlp",
"flags": "gimu",
"on_property": "body"
"on_property": ["title", "body"]
},
{
"pattern": "(.*nmt.*)|(.*bignlp.*)|(.*megatron.*)|(.*machine.*)|(.*translation.*)|(.*gpt.*)",
"target": "nmt",
"flags": "gimu",
"on_property": "title"
},
{
"pattern": "(.*nmt.*)|(.*bignlp.*)|(.*megatron.*)|(.*machine.*)|(.*translation.*)|(.*gpt.*)",
"target": "nmt",
"flags": "gimu",
"on_property": "body"
"on_property": ["title", "body"]
},
{
"pattern": "(.*tn.*)|(.*itn.*)|(.*text norm.*)",
"target": "tn",
"flags": "gimu",
"on_property": "title"
},
{
"pattern": "(.*tn.*)|(.*itn.*)|(.*text norm.*)",
"target": "tn",
"flags": "gimu",
"on_property": "body"
"on_property": ["title", "body"]
},
{
"pattern": "(.*sde.*)|(.*ctc segment.*)",
"target": "tools",
"flags": "gimu",
"on_property": "title"
},
{
"pattern": "(.*sde.*)|(.*ctc segment.*)",
"target": "tools",
"flags": "gimu",
"on_property": "body"
},
{
"pattern": "(.*trt.*)|(.*onnx.*)",
"target": "export",
"flags": "gimu",
"on_property": "title"
"on_property": ["title", "body"]
},
{
"pattern": "(.*trt.*)|(.*onnx.*)",
"pattern": "(.*trt.*)|(.*onnx.*)|(.*export.*)",
"target": "export",
"flags": "gimu",
"on_property": "body"
"on_property": ["title", "body"]
},
{
"pattern": "(.*doc.*)",
"pattern": "(.*\\[x\\] Documentation.*)",
"target": "docs",
"flags": "gimu",
"on_property": "title"
},
{
"pattern": "(.*doc.*)",
"target": "docs",
"flags": "gimu",
"on_property": "body"
"flags": "gmu",
"on_property": ["title", "body"]
},
{
"pattern": "(.*bug.*)|(.*bugfix.*)|(.*fix.*)|(.*patch.*)",
"pattern": "(.*\\[x\\] Bugfix.*)|(.*patch.*)",
"target": "bug",
"flags": "gimu",
"on_property": "title"
},
{
"pattern": "(.*bug.*)|(.*bugfix.*)|(.*fix.*)|(.*patch.*)",
"target": "bug",
"flags": "gimu",
"on_property": "body"
"flags": "gmu",
"on_property": ["title", "body"]
}
],
"duplicate_filter": {
Expand Down