-
Notifications
You must be signed in to change notification settings - Fork 383
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 changelog #240
Update changelog #240
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job compiling all of these. I've left some comments inline and also have 2 general comments:
- For links to PRs, you should be using format
[GH-XXX]
as described in [1]. - You should be using category names required by hashicorp automation [2] (I don't see
DOCS
orINTERNAL
there).
[1] https://www.terraform.io/docs/extend/best-practices/versioning.html#entry-format
[2] https://www.terraform.io/docs/extend/best-practices/versioning.html#categorization
CHANGELOG.md
Outdated
|
||
|
||
INTERNAL: | ||
* `datadog_monitor`: Start deprecating the silence attribute, support `-1` to unmute a scope, and get fix spruious diffs. ([#221](https://github.com/terraform-providers/terraform-provider-datadog/issues/221)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: spurious
CHANGELOG.md
Outdated
|
||
IMPROVEMENTS: | ||
* `datadog_monitor`: Use ForceNew when changing the Monitor type ([#236](https://github.com/terraform-providers/terraform-provider-datadog/issues/236)) | ||
* Update the vendored go client to `v2.21.0`. ([#230](https://github.com/terraform-providers/terraform-provider-datadog/issues/230)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd propose moving this to bottom, as it's something that's transparent to users of the provider (least important from my POV)
CHANGELOG.md
Outdated
* `datadog_monitor`: Start deprecating the silence attribute, support `-1` to unmute a scope, and get fix spruious diffs. ([#221](https://github.com/terraform-providers/terraform-provider-datadog/issues/221)) | ||
* Fix up the GCP and User acceptance tests ([#238](https://github.com/terraform-providers/terraform-provider-datadog/issues/238)) | ||
* Fix up the `datadog_downtime` and `datadog_monitor` acceptance tests. ([#234](https://github.com/terraform-providers/terraform-provider-datadog/issues/234)) | ||
* Cleanup go mod. ([#227](https://github.com/terraform-providers/terraform-provider-datadog/issues/227)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO this is not important at all for end users and I'd just leave it out of the changelog.
CHANGELOG.md
Outdated
|
||
INTERNAL: | ||
* `datadog_monitor`: Start deprecating the silence attribute, support `-1` to unmute a scope, and get fix spruious diffs. ([#221](https://github.com/terraform-providers/terraform-provider-datadog/issues/221)) | ||
* Fix up the GCP and User acceptance tests ([#238](https://github.com/terraform-providers/terraform-provider-datadog/issues/238)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think changes in the test suite are unimportant to end users and I'd leave all of these entries out.
CHANGELOG.md
Outdated
* `datadog_timebaord`: Add example on constructing dynamic timebaords. **NOTE** only supported with Terraform >= 0.12 ([#232](https://github.com/terraform-providers/terraform-provider-datadog/issues/232)) | ||
* `datadog_monitor`: Add example section for monitors configurations. ([#220](https://github.com/terraform-providers/terraform-provider-datadog/issues/220)) | ||
* `datadog_monitor`: Add link to the mapping of monitor types. ([#213](https://github.com/terraform-providers/terraform-provider-datadog/issues/213)) | ||
* `datadog_monitor`: Add clarify about API path not ending in `/api`. ([#207](https://github.com/terraform-providers/terraform-provider-datadog/issues/207)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add clarification...?
CHANGELOG.md
Outdated
DOCS: | ||
* `datadog_monitor`: Add an example of an anomaly monitor ([#239](https://github.com/terraform-providers/terraform-provider-datadog/issues/239)) | ||
* `datadog_monitor`: Clarify the units being used for `tick_every` and `min_failure_duration`. ([#233](https://github.com/terraform-providers/terraform-provider-datadog/issues/233)) Thanks [pratikmallya](https://github.com/pratikmallya) | ||
* `datadog_timebaord`: Add example on constructing dynamic timebaords. **NOTE** only supported with Terraform >= 0.12 ([#232](https://github.com/terraform-providers/terraform-provider-datadog/issues/232)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: timeboards
CHANGELOG.md
Outdated
IMPROVEMENTS: | ||
* `datadog_monitor`: Use ForceNew when changing the Monitor type ([#236](https://github.com/terraform-providers/terraform-provider-datadog/issues/236)) | ||
* Update the vendored go client to `v2.21.0`. ([#230](https://github.com/terraform-providers/terraform-provider-datadog/issues/230)) | ||
* `datadog_synthetics_test`: Support syntetics monitors in composite monitors. ([#222](https://github.com/terraform-providers/terraform-provider-datadog/issues/222)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: synthetics (you're missing the h
)
Thanks for the review. Mostly I was just following the existing changelog format. We need tooling around this 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM now, thanks!
* Update changelog * Address review * Fix links
Gets the changelog ready for the 2.0.0 release
I think I got everything, and tried to give credit in the changelog for external contributions.