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

doc: Update 1.12.0 release guide and Changelog #1488

Merged
merged 6 commits into from
Sep 21, 2023

Conversation

maastha
Copy link
Collaborator

@maastha maastha commented Sep 21, 2023

Description

This PR updates the Changelog and release guide for v1.12.0 of the provider to include guidance for this fix #1471

Link to any related issue(s):

Type of change:

  • 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

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contribution guidelines
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.

Further comments

@maastha maastha changed the title Update 1.12.0 release guide and Changelog doc: Update 1.12.0 release guide and Changelog Sep 21, 2023
@maastha maastha marked this pull request as ready for review September 21, 2023 14:00
@maastha maastha requested a review from a team as a code owner September 21, 2023 14:00
@maastha maastha requested a review from Zuhairahmed September 21, 2023 14:00
Copy link
Collaborator

@Zuhairahmed Zuhairahmed left a comment

Choose a reason for hiding this comment

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

Thanks for this @maastha! Made an additional commit and one suggestion. Also suggest let's wait to hear back from NTSE in case of any additional feedback before releasing v1.12.1. If nothing by tomorrow your time feel free to release.

website/docs/guides/1.12.0-upgrade-guide.html.markdown Outdated Show resolved Hide resolved
Copy link
Collaborator

@jwilliams-mongo jwilliams-mongo left a comment

Choose a reason for hiding this comment

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

@maastha LGTM % a few style tweaks + moving Breaking Changes earlier in that item

CHANGELOG.md Outdated
@@ -11,10 +11,10 @@

**Bug Fixes**

- Fix when removing `collectionName` from user role [\#1471](https://github.com/mongodb/terraform-provider-mongodbatlas/pull/1471) [Breaking Change] ([marcosuma](https://github.com/marcosuma))
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 breaking change should be the first thing in this item. I think we should also bold this text to make it stand out. Also a minor wording tweak to make the structure of this item align with the others.

Suggested change
- Fix when removing `collectionName` from user role [\#1471](https://github.com/mongodb/terraform-provider-mongodbatlas/pull/1471) [Breaking Change] ([marcosuma](https://github.com/marcosuma))
- **Breaking Change**: Fixes an issue where removing `collectionName` from user role didn't work [\#1471](https://github.com/mongodb/terraform-provider-mongodbatlas/pull/1471) ([marcosuma](https://github.com/marcosuma))

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
website/docs/guides/1.12.0-upgrade-guide.html.markdown Outdated Show resolved Hide resolved
@maastha maastha merged commit bf8b9e2 into master Sep 21, 2023
19 checks passed
@maastha maastha deleted the update-v12-release-guide branch September 21, 2023 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants