Add deprecation notice to charm (#61)

canonical · Sep 19, 2024 · 2e7d2de · 2e7d2de
1 parent 35fa4bc
commit 2e7d2de
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,6 +6,13 @@
 
 ## Description
 
+> [!NOTE]  
+> THIS CHARM IS DEPRECATED.
+>
+> The `traefik_route v0` library is DEPRECATED and is now maintained under https://github.com/canonical/traefik-k8s-operator.
+>
+> Please fetch the new library with `charmcraft fetch-lib charms.traefik_k8s.v0.traefik_route`.
+
 Traefik-route-k8s provides separation of concerns between the general needs of 
 the ingress and ingress-per-unit relation interfaces, and the need to specify 
 per-relation routing logic at runtime which in this case is specific to Traefik.

diff --git a/metadata.yaml b/metadata.yaml
@@ -5,8 +5,11 @@
 # https://juju.is/docs/sdk/metadata-reference
 name: traefik-route-k8s
 display-name: |
-  traefik-route-k8s
+  DEPRECATED traefik-route-k8s
 description: |
+  THIS CHARM IS DEPRECATED.
+
+  The `traefik_route v0` library is DEPRECATED and is now maintained under https://github.com/canonical/traefik-k8s-operator.
   Configuration charm for traefik-k8s. Flexible ingress-per-unit provider.
 summary: |
   Configuration charm for traefik-k8s. Flexible ingress-per-unit provider.