Add warning that matching behavior may change at any time

houseabsolute · Dec 26, 2024 · 5616fe8 · 5616fe8
1 parent 31009e7
commit 5616fe8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -147,6 +147,9 @@ better behavior.
 
 ## How `ubi` Finds the Right Release Artifact
 
+> [!WARNING] Note that the exact set of steps that `ubi` follows to find a release artifacts is not
+> considered part of the API, and may change in any future release.
+
 When `ubi` looks at the release assets (downloadable files) for a project, it tries to find the
 "right" asset for the platform it's running on. The matching logic currently works like this:
 

diff --git a/ubi/src/lib.rs b/ubi/src/lib.rs
@@ -44,6 +44,9 @@
 //!
 //! ## How `ubi` Finds the Right Release Artifact
 //!
+//! <div class="warning">Note that the exact set of steps that are followed to find a release
+//! artifacts is not considered part of the API, and may change in any future release.</div>
+//!
 //! When you call [`Ubi::install_binary`], it looks at the release assets (downloadable files) for a
 //! project and tries to find the "right" asset for the platform it's running on. The matching logic
 //! currently works like this: