Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit 3f2d9e8

Browse files
committed
Release v0.1
1 parent 1fcd20d commit 3f2d9e8

File tree

5 files changed

+26
-15
lines changed

5 files changed

+26
-15
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [0.1.0] - 2020-03-30
8+
9+
### Added
10+
11+
- First public version

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,12 @@ This GitHub Action provides faster version of the `cargo install` command.
2424
## How does it work?
2525

2626
Before calling your usual `cargo install` command, this Action
27-
attempts to download pre-build binary crate file from the binary crates cache.\
27+
attempts to download pre-build binary crate file from the binary crates cache.
2828
See [Security considerations](#security-considerations) to read more
2929
about potential caveats and usage policy.
3030

3131
If requested crate does not exist in the crates cache storage,
32-
this Action will fall back to the usual `cargo install`.
33-
32+
this Action will fall back to the usual `cargo install`.\
3433
As soon as [actions-rs/meta#21](https://github.com/actions-rs/meta/issues/21) will be implemented,
3534
this Action will also cache compiled binary in the GitHub cache.
3635

@@ -48,7 +47,7 @@ jobs:
4847
runs-on: ubuntu-latest
4948
steps:
5049
- uses: actions/checkout@v2
51-
- uses: actions-rs/install@master
50+
- uses: actions-rs/install@v0.1
5251
with:
5352
crate: cargo-audit
5453
version: latest
@@ -66,29 +65,30 @@ jobs:
6665
## Tool cache
6766

6867
As it was mentioned in [How does it work?](#how-does-it-work) section,
69-
this Action can use external cache with the pre-compiled crates in it.
68+
this Action can use external pre-compiled crates cache.
7069

71-
In order to use it, you need to **explicitly** enable `use-tool-cache` input:
70+
In order to enable this functionaliy, you need to **explicitly** enable `use-tool-cache` input:
7271

7372
```yaml
74-
- uses: actions-rs/install@master
73+
- uses: actions-rs/install@v0.1
7574
with:
7675
crate: cargo-audit
7776
version: latest
7877
use-tool-cache: true
7978
```
8079

8180
Before enabling this input, you should acknowledge security risks
82-
of executing pre-compiled binaries in your CI workflows.
81+
of executing binaries compiled for you by a third party in your CI workflows.
8382

8483
### Security considerations
8584

8685
Check the [`tool-cache`](https://github.com/actions-rs/tool-cache/) repo
87-
to under understand how binary crates are built, signed and uploaded to the external cache.
86+
to understand how binary crates are built, signed and uploaded into the external cache.
8887

89-
This Action downloads both binary file and its signature.\
90-
Signature validation is proceeded by `openssl` and public key (`public.pem`)
91-
of the same certificate used for signing files at `tool-cache` repo.
88+
This Action downloads both binary file and its signature.
89+
Signature validation is proceeded by `openssl` by using public key
90+
of the same certificate used for signing files at `tool-cache` repo.\
91+
Public key is stored in this repository at `public.pem`.
9292

9393
If signature validation fails, binary file is removed immediately,
9494
warning issued and fall back to the `cargo install` call happens.

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ inputs:
1313
required: false
1414
default: 'latest'
1515
use-tool-cache:
16-
description: Use tool cache to speed up installation (not used yet)
16+
description: Use tool cache to speed up installation
1717
required: false
1818
default: false
1919
use-cache:

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "rust-cargo-install",
3-
"version": "0.0.0",
3+
"version": "0.1.0",
44
"description": "Install a Rust binary crate as fast as possible",
55
"main": "lib/main.js",
66
"scripts": {

0 commit comments

Comments
 (0)