Skip to content

Commit

Permalink
Tweaked recommended deprecation message (#9693)
Browse files Browse the repository at this point in the history
Softened the language to not specify which major release resources will be removed in.
  • Loading branch information
melinath authored Dec 20, 2023
1 parent 748c8b0 commit 325b513
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/content/develop/make-a-breaking-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ Set `deprecation_message` on the resource. For example:

```yaml
deprecation_message: >-
`google_RESOURCE_NAME` is deprecated and will be removed in the next major release
of the provider. Use `google_OTHER_RESOURCE_NAME` instead.
`google_RESOURCE_NAME` is deprecated and will be removed in a future major release.
Use `google_OTHER_RESOURCE_NAME` instead.
```
Replace RESOURCE_NAME with the name of the resource (excluding the `google_` prefix). Replace the
Expand All @@ -145,8 +145,8 @@ The deprecation message will automatically show up in the resource documentation
```go
return &schema.Resource{
...
DeprecationMessage: "`google_RESOURCE_NAME` is deprecated and will be removed in the next " +
"major release of the provider. Use `google_OTHER_RESOURCE_NAME` instead.",
DeprecationMessage: "`google_RESOURCE_NAME` is deprecated and will be removed in a future " +
"major release. Use `google_OTHER_RESOURCE_NAME` instead.",
...
}
```
Expand All @@ -156,8 +156,8 @@ The deprecation message will automatically show up in the resource documentation
deprecation.
2. Add a warning to the resource documentation stating that the resource is deprecated. For example:
```markdown
~> **Warning:** `google_RESOURCE_NAME` is deprecated and will be removed in the next
major release of the provider. Use `google_OTHER_RESOURCE_NAME` instead.
~> **Warning:** `google_RESOURCE_NAME` is deprecated and will be removed in a future
major release. Use `google_OTHER_RESOURCE_NAME` instead.
```
{{< /tab >}}
{{< /tabs >}}
Expand Down

0 comments on commit 325b513

Please sign in to comment.