Skip to content

Match asset names with regex before os/arch/other filterings occur #122

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.

Sign up for GitHub

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

Merged
autarch merged 1 commit into from
Jun 8, 2025
Merged

Match asset names with regex before os/arch/other filterings occur #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## 0.6.2

- Added a new `--matching-regex` CLI flag and `UbiBuilder::matching_regex` method. This regex is
matched against potential release filenames _before_ attempting to find a release with a matching
OS, architecture, etc. This is useful for doing things like filtering for a single tool when a
project releases multiple tools in a single GitHub release.
- Changed dependency declarations to mostly eliminate default features, which removed quite a few
transitive dependencies.

Expand Down
113 changes: 60 additions & 53 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,59 +78,66 @@ current directory.
Usage: ubi [OPTIONS]

Options:
-p, --project <project> The project you want to install, like houseabsolute/precious or
https://github.com/houseabsolute/precious.
-t, --tag <tag> The tag to download. Defaults to the latest release.
-u, --url <url> The url of the file to download. This can be provided instead
of a project or tag. This will not use the forge site's API, so
you will never hit its API limits. With this parameter, you do
not need to set a token env var except for private repos.
--self-upgrade Use ubi to upgrade to the latest version of ubi. The --exe,
--in, --project, --tag, and --url args will be ignored.
-i, --in <in> The directory in which the binary should be placed. Defaults to
./bin.
-e, --exe <exe> The name of the file to look for in an archive file, or the
name of the downloadable file excluding its extension, e.g.
`ubi.gz`. By default this is the same as the project name, so
for houseabsolute/precious we look for precious or
precious.exe. When running on Windows the `.exe` suffix will be
added, as needed. You cannot pass `--extract-all` when this is
set.
--rename-exe <rename-exe-to> The name to use for the executable after it is unpacked. By
default this is the same as the name of the file passed for the
`--exe` flag. If that flag isn't passed, this is the same as
the name of the project. When running on Windows the `.exe`
suffix will be added, as needed. You cannot pass
`--extract-all` when this is set.
--extract-all Pass this to tell `ubi` to extract all files from the archive.
By default `ubi` will only extract an executable from an
archive file. But if this is true, it will simply unpack the
archive file. If all of the contents of the archive file share
a top-level directory, that directory will be removed during
unpacking. In other words, if an archive contains
`./project/some-file` and `./project/docs.md`, it will extract
them as `some-file` and `docs.md`. You cannot pass `--exe` or
`--rename-exe-to` when this is set.
-m, --matching <matching> A string that will be matched against the release filename when
there are multiple matching files for your OS/arch. For
example, there may be multiple releases for an OS/arch that
differ by compiler (MSVC vs. gcc) or linked libc (glibc vs.
musl). Note that this will be ignored if there is only one
matching release filename for your OS/arch.
--forge <forge> The forge to use. If this isn't set, then the value of
--project or --url will be checked for gitlab.com. If this
contains any other domain _or_ if it does not have a domain at
all, then the default is GitHub. [possible values: github,
gitlab]
--api-base-url <api-base-url> The the base URL for the forge site's API. This is useful for
testing or if you want to operate against an Enterprise version
of GitHub or GitLab. This should be something like
`https://github.my-corp.example.com/api/v4`.
-v, --verbose Enable verbose output.
-d, --debug Enable debugging output.
-q, --quiet Suppresses most output.
-h, --help Print help
-V, --version Print version
-p, --project <project>
The project you want to install, like houseabsolute/precious or
https://github.com/houseabsolute/precious.
-t, --tag <tag>
The tag to download. Defaults to the latest release.
-u, --url <url>
The url of the file to download. This can be provided instead of a project or tag. This
will not use the forge site's API, so you will never hit its API limits. With this
parameter, you do not need to set a token env var except for private repos.
--self-upgrade
Use ubi to upgrade to the latest version of ubi. The --exe, --in, --project, --tag, and
--url args will be ignored.
-i, --in <in>
The directory in which the binary should be placed. Defaults to ./bin.
-e, --exe <exe>
The name of the file to look for in an archive file, or the name of the downloadable file
excluding its extension, e.g. `ubi.gz`. By default this is the same as the project name,
so for houseabsolute/precious we look for precious or precious.exe. When running on
Windows the `.exe` suffix will be added, as needed. You cannot pass `--extract-all` when
this is set.
--rename-exe <rename-exe-to>
The name to use for the executable after it is unpacked. By default this is the same as
the name of the file passed for the `--exe` flag. If that flag isn't passed, this is the
same as the name of the project. Note that when set, this name is used as-is, so on
Windows, `.exe` will not be appended to the name given. You cannot pass `--extract-all`
when this is set.
--extract-all
Pass this to tell `ubi` to extract all files from the archive. By default `ubi` will only
extract an executable from an archive file. But if this is true, it will simply unpack the
archive file. If all of the contents of the archive file share a top-level directory, that
directory will be removed during unpacking. In other words, if an archive contains
`./project/some-file` and `./project/docs.md`, it will extract them as `some-file` and
`docs.md`. You cannot pass `--exe` or `--rename-exe-to` when this is set.
-m, --matching <matching>
A string that will be matched against the release filename when there are multiple
matching files for your OS/arch. For example, there may be multiple releases for an
OS/arch that differ by compiler (MSVC vs. gcc) or linked libc (glibc vs. musl). Note that
this will be ignored if there is only one matching release filename for your OS/arch.
-r, --matching-regex <matching-regex>
A regular expression string that will be matched against release filenames before matching
against your OS/arch. If the pattern yields a single match, that release will be selected.
If no matches are found, this will result in an error.
--forge <forge>
The forge to use. If this isn't set, then the value of --project or --url will be checked
for gitlab.com. If this contains any other domain _or_ if it does not have a domain at
all, then the default is GitHub. [possible values: github, gitlab]
--api-base-url <api-base-url>
The the base URL for the forge site's API. This is useful for testing or if you want to
operate against an Enterprise version of GitHub or GitLab. This should be something like
`https://github.my-corp.example.com/api/v4`.
-v, --verbose
Enable verbose output.
-d, --debug
Enable debugging output.
-q, --quiet
Suppresses most output.
-h, --help
Print help
-V, --version
Print version
```

## Using a Forge Token
Expand Down
13 changes: 13 additions & 0 deletions ubi-cli/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,16 @@ fn cmd() -> Command {
" is only one matching release filename for your OS/arch.",
)),
)
.arg(
Arg::new("matching-regex")
.long("matching-regex")
.short('r')
.help(concat!(
"A regular expression string that will be matched against release filenames before",
" matching against your OS/arch. If the pattern yields a single match, that release",
" will be selected. If no matches are found, this will result in an error.",
)),
)
.arg(
Arg::new("forge")
.long("forge")
Expand Down Expand Up @@ -217,6 +227,9 @@ fn make_ubi<'a>(
if let Some(m) = matches.get_one::<String>("matching") {
builder = builder.matching(m);
}
if let Some(r) = matches.get_one::<String>("matching-regex") {
builder = builder.matching_regex(r);
}
if let Some(e) = matches.get_one::<String>("exe") {
builder = builder.exe(e);
}
Expand Down
16 changes: 16 additions & 0 deletions ubi-cli/tests/ubi.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,22 @@ fn integration_tests() -> Result<()> {
make_exe_pathbuf(&["bin", "scorecard"]),
)?;

run_test(
td.path(),
ubi.as_ref(),
&[
"--project",
"shader-slang/slang",
"--tag",
"v2025.9.2",
"--exe",
"slangc",
"--matching-regex",
r"\d+\.tar",
],
make_exe_pathbuf(&["bin", "slangc"]),
)?;

Ok(())
}

Expand Down
19 changes: 18 additions & 1 deletion ubi/src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ pub struct UbiBuilder<'a> {
url: Option<&'a str>,
install_dir: Option<PathBuf>,
matching: Option<&'a str>,
matching_regex: Option<&'a str>,
exe: Option<&'a str>,
rename_exe_to: Option<&'a str>,
extract_all: bool,
Expand Down Expand Up @@ -96,6 +97,16 @@ impl<'a> UbiBuilder<'a> {
self
}

/// Set a regular expression string that will be matched against release filenames before
/// matching against your OS/arch. If the pattern yields a single match, that release will be
/// selected. If no matches are found, then the `Ubi::install_binary` method will return an
/// error when it is run.
#[must_use]
pub fn matching_regex(mut self, matching_regex: &'a str) -> Self {
self.matching_regex = Some(matching_regex);
self
}

/// Set the name of the executable to look for in archive files. By default this is the same as
/// the project name, so for `houseabsolute/precious` we look for `precious` or
/// `precious.exe`. When running on Windows the ".exe" suffix will be added as needed.
Expand Down Expand Up @@ -236,7 +247,13 @@ impl<'a> UbiBuilder<'a> {
Ok(Ubi::new(
forge,
asset_url,
AssetPicker::new(self.matching, platform, is_musl, self.extract_all),
AssetPicker::new(
self.matching,
self.matching_regex,
platform,
is_musl,
self.extract_all,
),
installer,
reqwest_client()?,
))
Expand Down
Loading
Loading