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

Jump to bottom

doc: HashiCorp Terraform Version Compatibility Matrix #1969

Merged
merged 12 commits into from
Feb 23, 2024
Merged

doc: HashiCorp Terraform Version Compatibility Matrix #1969

merged 12 commits into from
Feb 23, 2024

Conversation

Zuhairahmed
Copy link
Collaborator

@Zuhairahmed Zuhairahmed commented Feb 21, 2024 •
edited
Loading

Description

Please include a summary of the fix/feature/change, including any relevant motivation and context.
Updates our external facing docs for HashiCorp Terraform Version Compatibility Matrix

Link to any related issue(s): CLOUDP-218730

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 checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • 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.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

@Zuhairahmed Zuhairahmed requested a review from a team as a code owner February 21, 2024 20:15
@Zuhairahmed Zuhairahmed changed the title HashiCorp Compatibility Matrix Updates doc: HashiCorp Compatibility Matrix Updates Feb 21, 2024
@Zuhairahmed Zuhairahmed changed the title doc: HashiCorp Compatibility Matrix Updates doc: HashiCorp Terraform Versioning Compatibility Matrix Updates Feb 21, 2024
@Zuhairahmed Zuhairahmed changed the title doc: HashiCorp Terraform Versioning Compatibility Matrix Updates doc: HashiCorp Terraform Version Compatibility Matrix Updates Feb 21, 2024
@Zuhairahmed Zuhairahmed changed the title doc: HashiCorp Terraform Version Compatibility Matrix Updates doc: HashiCorp Terraform Version Compatibility Matrix Feb 21, 2024
lantoli
lantoli reviewed Feb 21, 2024
View reviewed changes
README.md Outdated
## Requirements
- [HashiCorp Terraform Version](https://www.terraform.io/downloads.html) Compatibility Matrix

| HashiCorp Terraform Release | HashiCorp Terraform Release Date | HashiCorp Terraform Full Support End Date | MongoDB Atlas Support End Date |
Copy link
Member

@lantoli lantoli Feb 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

i would probably have the table only in one place and make reference to it, e.g. to: https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

makes sense, updated

lantoli
lantoli reviewed Feb 21, 2024
View reviewed changes
website/docs/index.html.markdown
| below `1.12.0` | `0.13+` |

* While we support minimum of HashiCorp Terraform version 1.0+ (as we have migrated to [Plugin Protocol Version 6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6)), for your safety we strongly recommend only consuming versions of Terraform that are currently receiving Security/Maintenance Updates. For latest Terraform versions see: https://endoflife.date/terraform
## [HashiCorp Terraform Version](https://www.terraform.io/downloads.html) Compatibility Matrix
Copy link
Member

Choose a reason for hiding this comment

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

my feeling is that this info is very below in the page but i suppose it doesn't fit more above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

played around with the spacing, hope this helps with readability

@lantoli
Copy link
Member

lantoli commented Feb 22, 2024

LGTM

maastha
maastha reviewed Feb 22, 2024
View reviewed changes
website/docs/index.html.markdown
| below `1.12.0` | `0.13+` |

* While we support minimum of HashiCorp Terraform version 1.0+ (as we have migrated to [Plugin Protocol Version 6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6)), for your safety we strongly recommend only consuming versions of Terraform that are currently receiving Security/Maintenance Updates. For latest Terraform versions see: https://endoflife.date/terraform
## [HashiCorp Terraform Version](https://www.terraform.io/downloads.html) Compatibility Matrix
Copy link
Collaborator

Choose a reason for hiding this comment

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

[q] do we plan to include a mention in our next release guide about the Compatibility matrix to notify users? Or would the changelog suffice?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggest we mention in both places with link to Terraform Docs. Added additional commit with updates to upcoming Upgrade Guide. ChangeLog will be pulled in automatically from the ChangeLog auto-generation, will also manually adjust as needed when we get there.

AgustinBettati
AgustinBettati approved these changes Feb 22, 2024
View reviewed changes
Copy link
Member

@AgustinBettati AgustinBettati left a comment

Choose a reason for hiding this comment

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

LGTM

@Zuhairahmed Zuhairahmed merged commit e22e066 into master Feb 23, 2024
44 checks passed
@Zuhairahmed Zuhairahmed deleted the Compatbility-matrix-updates branch February 23, 2024 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maastha maastha maastha left review comments

@lantoli lantoli lantoli approved these changes

@AgustinBettati AgustinBettati AgustinBettati approved these changes

@marcosuma marcosuma marcosuma approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Zuhairahmed @lantoli @marcosuma @AgustinBettati @maastha