Skip to content

deprecation: Indicate that admin mutation GETs are deprecated.#3001

Merged
mattklein123 merged 5 commits intoenvoyproxy:masterfrom
jmarantz:admin-mutation-get-deprecation
Apr 5, 2018
Merged

deprecation: Indicate that admin mutation GETs are deprecated.#3001
mattklein123 merged 5 commits intoenvoyproxy:masterfrom
jmarantz:admin-mutation-get-deprecation

Conversation

@jmarantz
Copy link
Copy Markdown
Contributor

@jmarantz jmarantz commented Apr 4, 2018

Signed-off-by: Joshua Marantz jmarantz@google.com

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

Signed-off-by: Joshua Marantz <jmarantz@google.com>
DEPRECATED.md Outdated
or `regex_match` oneof instead.


* Admin mutations should be sent as POSTs rather than GETs. Starting in 1.7, these will result
Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Member

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 <jmarantz@google.com>
DEPRECATED.md Outdated

The following features have been DEPRECATED and will be removed in the specified release cycle.

## Version 1.7.0...
Copy link
Copy Markdown
Member

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).

Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Contributor Author

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 <jmarantz@google.com>
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
Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

@ccaraman ccaraman self-assigned this Apr 5, 2018
jmarantz added 2 commits April 5, 2018 16:48
Signed-off-by: Joshua Marantz <jmarantz@google.com>
…p those up-to-date.

Signed-off-by: Joshua Marantz <jmarantz@google.com>
Copy link
Copy Markdown
Member

@mattklein123 mattklein123 left a 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?

@mattklein123 mattklein123 merged commit 36eb9e7 into envoyproxy:master Apr 5, 2018
@jmarantz jmarantz deleted the admin-mutation-get-deprecation branch April 5, 2018 23:35
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.

3 participants