Commit graph

63 commits

Author SHA1 Message Date
Alejandro González
b599493600
docs: mention quickinstall telemetry collection in --help and README (#1890)
* docs: mention `quickinstall` telemetry collection in `--help` and README

These changes describe the usage statistics collected when the
`quickinstall` strategy is used by default, according to the discussion
and details brought forward on
https://github.com/cargo-bins/cargo-binstall/issues/1884. Both the
project README and the CLI long help contain clear disclosures of such
statistics collection now.

Signed-off-by: Alejandro González <me@alegon.dev>

* docs: add some more data collection details

Signed-off-by: Alejandro González <me@alegon.dev>

---------

Signed-off-by: Alejandro González <me@alegon.dev>
2024-08-20 10:24:13 +00:00
Jiahao XU
5a316b765f
Fix url link in README.md (#1820)
Fixed  #1819

Signed-off-by: Jiahao XU <30436523+NobodyXu@users.noreply.github.com>
2024-07-15 14:10:12 +00:00
Jiahao XU
1b21c1d468
Include instruction to install using homebrew (#1793)
* Include instruction to install using homebrew

cargo-binstall is now in homebrew-core, so update our REAMDE to reflect that!

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Update README.md

 - Fix typo
 - Add link to homebrew

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

---------

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
2024-06-20 10:12:26 +00:00
Félix Saparelli
c8e93d4a24
Renew readme (#1524)
- Reorders sections to show Binstall's value upfront
- Clarifies and simplifies language
- Updates the sample output
- Includes cargo-run-bin (#1514)
- Places the github actions in more prominence in the Install section
- Unifies appellation by consistently using the "Binstall" name except for commands
- Changes the arch labels in the install table to reflect common/official usage
2023-12-13 06:39:08 +00:00
Yuri Astrakhan
9d8dc94d8d
Fix badge (#1494)
It was pointing to an non-existent CI job, changed it to CI workflow.
2023-11-14 03:03:31 +00:00
Félix Saparelli
32beba507b
Initial signing support (#1345)
* Add CLI options

* Add manifest types

* Thread signature policy through to fetchers

* Thread signing section through from metadata

* Implement signing validation

* Clippy

* Attempt testing

* Yes and

* Why

* fmt

* Update crates/bin/src/args.rs

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* Update crates/binstalk-fetchers/src/gh_crate_meta.rs

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* Update crates/bin/src/args.rs

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* Update crates/binstalk-fetchers/src/signing.rs

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* Update crates/binstalk-fetchers/src/signing.rs

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* Update crates/binstalk-fetchers/src/signing.rs

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* Update crates/binstalk-fetchers/src/signing.rs

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* fixes

* Finish feature

* Document

* Include all fields in the signing.file template

* Readme document

* Review fixes

* Fail on non-utf8 sig

* Thank goodness for tests

* Run test in ci

* Add rsign2 commands

* Log utf8 error

* Update e2e-tests/signing.sh

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

* Fix `e2e-tests/signing.sh` MacOS CI failure

Move the tls cert creation into `signing.sh` and sleep for 10s to wait
for https server to start.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Refactor e2e-tests-signing files

 - Use a tempdir generated by `mktemp` for all certificates-related
   files
 - Put other checked-in files into `e2e-tests/signing`

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Fixed `e2e-tests-signing` connection err in MacOS CI

Wait for server to start up by trying to connect to it.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Fix `e2e-tests-signing` passing `-subj` to `openssl` on Windows

Use single quote instead of double quote to avoid automatic expansion
from bash

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Fix `e2e-tests-signing` waiting for server to startup

Remove `timeout` since it is not supported on MacOS.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Try to fix windows CI by setting `MSYS_NO_PATHCONV=1` on `openssl` cmds

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Fixed `e2e-tests-signing` on windows

By using double `//` for the value passed to option `-subj`

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Fixed infinite loop in `signing/wait-for-server` on Windows

Pass `--ssl-revoke-best-effort` to prevent schannel from checking ssl
revocation status.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Add cap on retry attempt in `signing/wait-for-server.sh`

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Let `singing/server.py` print output to stderr

so that we can see the error message there.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

* Fix running `signing/server.py` on MacOS CI

use `python3` since macos-latest still has python2 installed and
`python` is a symlink to `python2` there.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

---------

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>
2023-09-23 04:02:56 +00:00
Marcin Nowak-Liebiediew
42dddd972d
Add GitHub Action declaration for installing cargo-binstall (#1269)
add action.yml and test it
2023-08-09 20:50:16 +00:00
Aadi Desai
a849db3ef4
Add one-liner for installing cargo-binstall on Windows (#1099)
* Add one-liner for installing `cargo-binstall` on Windows

* Change command separator to semicolon

`&&` was added in Powershell 7

* Update win install script to exit on error and trace
2023-06-03 09:15:11 +00:00
xxchan
316dc50dff
fix typo (#1090) 2023-05-26 14:25:13 +12:00
Jiahao XU
c9806cce78
Add one-liner for installing cargo-binstall on Linux/MacOS (#1074)
Fixed #1073

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
2023-05-24 08:22:41 +00:00
David Weis
0de3b21004
Fix download link for armv7 release in readme (#980
Fix download link for armv7 in readme
2023-04-06 12:31:28 +12:00
EdJoPaTo
620d0e5f9e
docs(readme): fix link to metadata (#877)
Co-authored-by: Félix Saparelli <felix@passcod.name>
2023-03-11 13:56:57 +13:00
Jiahao XU
abb6874da3
Update README: Include aarch64 windows and full build info (#700)
* Update README: Include aarch64 windows and full build info

Co-authored-by: Félix Saparelli <felix@passcod.name>
2023-01-13 23:46:18 +11:00
Félix Saparelli
ce411910a9
Linux split debuginfo is already here actually (#672) 2023-01-09 21:30:35 +11:00
Félix Saparelli
aea9df602c
Migrate CI and builds to Just, add "full" builds (#660) 2023-01-08 16:27:36 +11:00
Jiahao XU
707b173de1
Create universal binary for MacOS in workflow release (#551)
* Create universal binary for MacOS in workflow build
* Update README

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
2022-11-22 16:52:36 +11:00
Steven Hé (Sīchàng)
e378be73df
Mention upgrade, fix #514 (#524)
Fix #514
2022-11-10 03:58:52 +00:00
azzamsa
3a71c5a5c4
docs: update unsupported crates guide (#468)
Fixes #467
2022-10-08 08:21:50 +00:00
Jiahao XU
9ee78f3736
Update README (#464)
Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
2022-10-08 02:42:30 +13:00
github-actions[bot]
af3316a8f3
release: cargo-binstall v0.14.0 (#443)
* release: cargo-binstall v0.14.0

* Fix README

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>
2022-09-28 06:41:16 +00:00
Jiahao XU
aa12109f3e
Fixed link to BinstallError in README.md (#397) 2022-09-18 15:41:42 +12:00
Félix Saparelli
6bd1fc68b5
Use github source for latest version readme (#395)
The crate _doesn't_ have the readme snapshot anymore, likely due to
the new split crate layout; we should probably fix that but in the
meantime this does the trick.
2022-09-17 22:27:52 +10:00
Jiahao XU
946dd2d0b9
Avoid misleading confusion of README.md (#392)
Fixed #391
2022-09-17 22:34:38 +12:00
azzamsa
a611b824fd
docs: fix grammatical error (#386) 2022-09-16 02:55:19 +00:00
azzamsa
a5ffba1ffb
docs: add unsupported crate example (#385) 2022-09-15 21:22:28 +10:00
Félix Saparelli
56bafc8c9b
Add install recommendation to readme (#351) 2022-09-09 08:27:54 +00:00
Félix Saparelli
73f7719e53
Recommend taiki-e/install-action (#342)
See #309
2022-09-05 15:12:56 +12:00
Félix Saparelli
763d4610e5
Don't prompt if there's nothing to do (#293)
Fixes #291
2022-08-09 09:09:21 +00:00
ryan kurte
5c703f30ca add note about quickinstall / cargo install fallback 2022-08-08 11:42:06 +12:00
ryan kurte
b3f6eb64ea split docs, first step towards simplifying support instructions 2022-08-06 09:44:17 +12:00
Félix Saparelli
43511690f4
Add tbz2 to readme 2022-06-23 06:37:43 +12:00
Félix Saparelli
6ab55d9dda
Fix arm64 linux URL 2022-06-01 01:46:28 +12:00
Félix Saparelli
aa4339e07d
Expose crate::errors module 2022-06-01 00:29:17 +12:00
Félix Saparelli
d21c4a0875
Add link to error code descriptions 2022-06-01 00:29:17 +12:00
Jiahao XU
a59057b932
Update README.md: Tar.zst is now supported by cargo-binstall
Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
2022-05-31 16:59:00 +10:00
Félix Saparelli
2f9be15c30
Fix old template specifier in readme 2022-05-31 18:01:29 +12:00
Lea Fairbanks
19d0616324
Add cli overrides 2022-05-31 18:00:07 +12:00
Félix Saparelli
bee95cdb27
Fix markdown 2022-05-31 17:24:52 +12:00
Félix Saparelli
22f509fb72
Add macos arm64 to readme 2022-05-31 17:24:42 +12:00
Félix Saparelli
c1fd2398f0
Add linux arm64 to readme 2022-05-31 17:24:04 +12:00
Félix Saparelli
3a1d42fd6b
Default to musl builds on the readme 2022-05-31 17:19:56 +12:00
Félix Saparelli
dd33a1d66e Mention source fallback in readme 2022-04-29 10:21:09 +12:00
Félix Saparelli
6dcb1dd1b4
Split {format} and allow use of {binary-ext} in pkg-url (#95)
This from feedback in #19:

> wrt. bin-dir and bin-path, this appears to be a typo / should all be called bin-dir

This is only a readme fix afaict, I changed all occurences of `bin-path` in there to `bin-dir`.

> wrt. format, those are actually two (unfortunately named) different concepts, the first
refers to the archive format (eg. .tgz), the second to the binary format (which needs a .exe
appended for windows).

This introduces two new substitutions:
- `binary-ext` is the old "`format` in `bin-dir`"
- `archive-format` is the old "`format` in `pkg-url`"

Contents are unchanged: `binary-ext` includes the dot, `archive-format` doesn't. That
makes it easy to upgrade and also personally I slightly prefer it that way.

The old contextual `format` is still available, "soft deprecated": it will be accepted silently
so everything will work, but all documentation will use the new syntax. In the future we
could move to a "hard deprecated" model where installing a package that uses `format`
will warn the user / tell them to report that to the maintainer. I don't think we'll ever really
be able to remove it but that should be good enough.

A cool new feature is that `binary-ext` is now usable in `pkg-url`, which will be useful for raw binary downloads:

```toml
pkg_url = "{ repo }/releases/download/v{ version }/{ name }-v{ version }-{ target }{ binary-ext }"
```

I've also added a bunch of tests to GhCrateMeta around the templating for `pkg-url`.
2022-02-16 16:18:35 +13:00
Félix Saparelli
370ae05620
QuickInstall support (#94)
See this issue: https://github.com/alsuren/cargo-quickinstall/issues/27

Quick Install is a hosted repo of built crates, essentially. The approach I've taken here is
a list of strategies:

1. First, we check the crate meta or default and build the URL to the repo. Once we have
   that, we perform a `HEAD` request to the URL to see if it's available.
2. If it's not, we build the URL to the quickinstall repo, and perform a `HEAD` to there.

As soon as we've got a hit, we use that. I've built it so it's extensible with more strategies.
This could be useful for #4.

This also adds a prompt before downloading from third-party sources, and logs a short
name for a source, which is easier to glance than a full URL, and includes a quick refactor
of the install/link machinery.
2022-02-16 14:49:07 +13:00
Ryan
8b4e77918c
Update README.md
Add curl commands for fetching latest release archives to readme
2021-10-22 18:45:51 +13:00
pinage404
71c6b0d209 fix: typo 2021-10-17 12:45:53 +02:00
ryan
76a7fb00c9 add pkg-url and pkg-fmt overrides 2021-04-08 21:26:44 +12:00
ryan
1c25b1346f added zip support, pkg-fmt override
swapped CI to build zips for windows
2021-04-08 18:39:54 +12:00
Félix Saparelli
9c06ca94cb
Add support for Txz archives 2021-03-06 22:35:05 +13:00
Ryan
6d18b7bb1e
Update README.md 2021-01-01 10:16:00 +13:00