Add deprecation warning to README.md (#35)

* Add deprecation warning to README.md * changelog
solo-io · Nov 5, 2024 · 318d618 · 318d618
1 parent 9d1d546
commit 318d618
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> ExtAuthPlugin has been deprecated in favor of ExtAuth Passthrough. Please refer to the [Gloo Gateway docs](https://docs.solo.io/gloo-edge/latest/guides/security/auth/extauth/passthrough_auth/) for more information.
+
+---
+
 <h1 align="center">
     <img src="https://github.com/solo-io/ext-auth-plugin-examples/raw/master/img/gloo-plugin.png" alt="Gloo Plugins" width="440" height="309">
   <br>

diff --git a/changelog/v0.4.0/deprecation-notice b/changelog/v0.4.0/deprecation-notice
@@ -0,0 +1,5 @@
+changelog:
+- type: FIX
+  description: Add a warning to the README informing users that ExtAuthPlugin is deprecated and direct users to the safer alternative, [ExtAuth Passthrough](https://docs.solo.io/gloo-edge/latest/guides/security/auth/extauth/passthrough_auth/).
+  issueLink: https://github.com/solo-io/solo-projects/issues/6961
+  resolvesIssue: false