INTMDB-720: [Terraform] Investigate ChangeLog Generator (#1165)

mongodb · May 15, 2023 · 882524f · 882524f
1 parent f7455e5
commit 882524f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -6,9 +6,9 @@ Link to any related issue(s):
 
 ## Type of change:
 
-- [ ] 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)
+- [ ] Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
+- [ ] New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
 - [ ] This change requires a documentation update
 - [ ] Documentation fix/enhancement
 

diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1,11 @@
+# Releasing
+
+## Prerequisites
+
+- [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator)
+
+# Generating the CHANGELOG.md
+Run: 
+```bash 
+github_changelog_generator -u mongodb -p terraform-provider-mongodbatlas --enhancement-label "**Enhancements**" --bugs-label "**Bug Fixes**"
+```