-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
deprecation: Indicate that admin mutation GETs are deprecated. #3001
deprecation: Indicate that admin mutation GETs are deprecated. #3001
Conversation
Signed-off-by: Joshua Marantz <[email protected]>
DEPRECATED.md
Outdated
@@ -19,6 +19,11 @@ The following features have been DEPRECATED and will be removed in the specified | |||
* `value` and `regex` fields in the `HeaderMatcher` message is deprecated. Use the `exact_match` | |||
or `regex_match` oneof instead. | |||
|
|||
|
|||
* Admin mutations should be sent as POSTs rather than GETs. Starting in 1.7, these will result |
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.
Please make a new 1.7.0 version section above the 1.6.0 version and add 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.
OK. I thought that we were declaring it deprecated effectively now. In 1.7 it would be beyond deprecated, so to speak.
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.
It is deprecated now, made official in 1.7, and then we can make the switch right after 1.7 is released.
Signed-off-by: Joshua Marantz <[email protected]>
DEPRECATED.md
Outdated
@@ -5,6 +5,12 @@ As of release 1.3.0, Envoy will follow a | |||
|
|||
The following features have been DEPRECATED and will be removed in the specified release cycle. | |||
|
|||
## Version 1.7.0... |
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.
Can we remove the 3 dots? I'm not sure it's worth adding another step here to switch this back at official release time. If so, can you update the release instructions? https://github.com/envoyproxy/envoy/blob/master/GOVERNANCE.md#cutting-a-release (@htuch heads up that when you do the data-plane-api work we will need to update the release instructions).
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.
Removed the dots. I'm not sure why I thought that would be helpful. I find it confusing because it's hard to tell from looking at this that 1.7 is in the future. Maybe we can -- in a separate PR, add dates to the past releases, and have the release instructions include assigning a date to pending releases here once they are out.
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.
If you want to add some like you are doing in the release notes like "pending", or add dates below with "in progress" that's fine. I would just make a note in the release process check list that this file needs to be updated also. Can you do that as part of this PR?
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.
OK, done; let me know what you think.
Signed-off-by: Joshua Marantz <[email protected]>
DEPRECATED.md
Outdated
## Version 1.7.0 | ||
|
||
* Admin mutations should be sent as POSTs rather than GETs. These will result in an error | ||
status code, and will not have their intended effect. Prior to 1.7, GETs can be used for |
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.
nit second senter 'and will' is incomplete
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.
done
Signed-off-by: Joshua Marantz <[email protected]>
…p those up-to-date. Signed-off-by: Joshua Marantz <[email protected]>
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.
Nice, thanks. Can you add the dates to the release notes RST also?
Signed-off-by: Joshua Marantz [email protected]
Description:
adds a deprecation message.
Risk Level: Low
Testing: none
Docs Changes: N/A -- the desired state is already docced.
Release Notes: envoyproxy/data-plane-api#606