-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs: clarify registry backend acceptance policy #9543
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
Changes from 1 commit
e9d9c5c
472a5e8
92f598c
2f8857b
80ad13c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -624,13 +624,21 @@ of the full backend specification. | |||||||||
| When adding a new tool, the following requirements apply (automatically | ||||||||||
| enforced by [GitHub Actions workflow](https://github.com/jdx/mise/blob/main/.github/workflows/registry_comment.yml)): | ||||||||||
|
|
||||||||||
| - **New asdf plugins are not accepted** - Use aqua/github instead | ||||||||||
| - **New asdf and vfox plugins are not accepted** - Use [aqua](dev-tools/backends/aqua.md) | ||||||||||
| (preferred) or [github](dev-tools/backends/github.md) instead. This is a supply-chain | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The links use the
Suggested change
|
||||||||||
| security policy. | ||||||||||
| - **The `ubi` backend is deprecated and will not be accepted** for new registry entries. | ||||||||||
| Use aqua/github instead. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||||||
| - **Other backends (`npm`, `pipx`, `cargo`, `gem`, `go`, `dotnet`, etc.) have a very high | ||||||||||
| bar** for new registry entries. They are accepted only when no aqua/github option exists | ||||||||||
| and the tool is widely used. Discuss with @jdx before submitting. | ||||||||||
| - **A test is required in `registry/`** - Must include a `test` field to | ||||||||||
| verify installation | ||||||||||
| - **Tools may be rejected if they are not notable** - The tool should be | ||||||||||
| reasonably popular and well-maintained. There are no specific guidelines for this and | ||||||||||
| a lot of factors are taken into account. @jdx won't explain why a given tool wasn't | ||||||||||
| accepted. | ||||||||||
| accepted. Include a brief popularity summary (stars, downloads, recent release date) in | ||||||||||
| the PR description so the policy can be applied without re-doing the research. | ||||||||||
|
|
||||||||||
| ### Registry Format | ||||||||||
|
|
||||||||||
|
|
||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -39,7 +39,7 @@ In general, the preferred [backend](/dev-tools/backends/) to use for new tools i | |||||
| - [cargo](./dev-tools/backends/cargo.html) - only for rust tools, requires rust to be installed to compile. Because rust tools can be distributed as a single binary, aqua/github are definitely preferred. | ||||||
| - [dotnet](./dev-tools/backends/dotnet.html) - only for dotnet tools, requires dotnet to be installed to compile. Because dotnet tools can be distributed as a single binary, aqua/github are definitely preferred. | ||||||
|
|
||||||
| New vfox and asdf tools are almost never accepted for supply-chain security reasons. | ||||||
| New `vfox` and `asdf` tools are not accepted for supply-chain security reasons — use `aqua` (preferred) or `github` instead. The `ubi` backend is deprecated and is not accepted for new registry entries. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider adding links to the
Suggested change
|
||||||
|
|
||||||
| ### Backends Priority | ||||||
|
|
||||||
|
|
||||||
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.
The inclusion of
ubi:in this list of backends with a 'high bar' contradicts line 49, which states it will not be accepted under any circumstances. It should be removed from this list for clarity.