-
Notifications
You must be signed in to change notification settings - Fork 918
Add more visible deprecation banner to the 1.17 readme #2233
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
Add more visible deprecation banner to the 1.17 readme #2233
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.
Pull Request Overview
This PR adds a prominent deprecation notice to the 1.17 readme to inform users that v1 of the Go driver is no longer actively developed and will reach end-of-life in early 2026. The notice encourages users to upgrade to v2 for new features while clarifying that bug fixes and critical updates will continue until early 2026.
- Adds a bold, red deprecation banner at the top of the README
- Communicates the end-of-life timeline and support policy
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
API Change ReportNo changes found! |
README.md
Outdated
| @@ -1,3 +1,9 @@ | |||
| <p style="text-align:center; font-size:1.25em; font-weight:bold; color:red; padding:2em;"> | |||
| This version of the Go driver is no longer actively developed and will not receive new features. | |||
| For new features, please upgrade to the next major version. | |||
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.
Suggestion for 2nd line: "For access to the latest features and improvements, we encourage you to upgrade to the new major version(v2.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.
Good point. Updated but used v2.x for the version number, as we don't want people to use 2.0 either.
Summary
This adds a more visible deprecation banner to the readme to encourage users to upgrade to v2 of the driver in light of the upcoming end-of-life of v1.