Update pr template and re-add Changelog builder (#3575)

* Update changelog to add authors Signed-off-by: smajumdar <[email protected]> * Update changelog to add authors Signed-off-by: smajumdar <[email protected]> * Update changelog to add authors Signed-off-by: smajumdar <[email protected]> * Correct configS Signed-off-by: smajumdar <[email protected]> * Correct configS Signed-off-by: smajumdar <[email protected]> * Correct configS Signed-off-by: smajumdar <[email protected]> * Update changelog Signed-off-by: smajumdar <[email protected]> * Fix extra , Signed-off-by: smajumdar <[email protected]> * Update according to suggestions Signed-off-by: smajumdar <[email protected]> Co-authored-by: Eric Harper <[email protected]>
NVIDIA · Mar 2, 2022 · b7d3d81 · b7d3d81
1 parent 7152327
commit b7d3d81
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 79 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,15 +1,31 @@
-# What does this PR do?
+# What does this PR do ?
 
-Please have one of the following:
+Add a one line overview of what this PR aims to accomplish.
 
-* Fixes # (issue)
-* New feature: (short feature description)
+**Collection**: [Note which collection this PR will affect]
 
-## Before your PR is "Ready for review"
+# Changelog 
+- Add specific line by line info of high level changes in this PR.
+
+# Usage
+* You can potentially add a usage example below
+
+```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**:
+- [ ] New Feature
+- [ ] Bugfix
+- [ ] Documentation
 
 If you haven't finished some of the above items you can still open "Draft" PR.
 
@@ -18,3 +34,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)
diff --git a/.github/workflows/changelog-build.yml b/.github/workflows/changelog-build.yml
@@ -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
 
@@ -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:

diff --git a/.github/workflows/config/changelog-config.json b/.github/workflows/config/changelog-config.json
@@ -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": {