Better logs and readme

Author: svartalf

README.md

@@ -1,3 +1,81 @@
-This repo is an ongoing attempt to do some thing.
+# `cargo-install` Action
 
-Do not use it.
+[![Sponsoring](https://img.shields.io/badge/Support%20it-Say%20%22Thank%20you!%22-blue)](https://actions-rs.github.io/#sponsoring)
+![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)
+[![Gitter](https://badges.gitter.im/actions-rs/community.svg)](https://gitter.im/actions-rs/community)
+![Continuous integration](https://github.com/actions-rs/install/workflows/Continuous%20integration/badge.svg)
+![Dependabot enabled](https://api.dependabot.com/badges/status?host=github&repo=actions-rs/toolchain)
+
+This GitHub Action provides faster version of the `cargo install` command.
+
+⚠ ️**NOTE: Work on this Action is still in progress, no guarantees on stability, correctness or security are provided right now.** ⚠
+
+**Table of Contents**
+
+* [How does this works?](#how-does-it-work)
+* [Example workflow](#example-workflow)
+* [Inputs](#inputs)
+* [Security considerations](#security-considerations)
+* [License](#license)
+* [Contribute and support](#contribute-and-support)
+
+## How does it work?
+
+1. Most popular binary crates used in Rust CI are selected for the speed-up installation
+2. They are compiled directly at GitHub virtual environments
+3. Then they are uploaded into the external storage
+4. When you use this Action to install one of these crates,
+   it will be downloaded from this cache storage
+5. If crate was not found in the cache storage, usual `cargo install` will be invoked instead.
+
+As soon as https://github.com/actions-rs/meta/issues/21 will be implemented,
+this Action will also cache resulting binary in the GitHub cache after compilation.
+
+## Example workflow
+
+```yaml
+on: [push]
+
+name: build
+
+jobs:
+  check:
+    name: Rust project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/install@master
+        with:
+          crate: cargo-audit
+          version: latest
+      - run: cargo audit
+```
+
+## Inputs
+
+| Name         | Required | Description              | Type   | Default |
+| ------------ | :------: | -------------------------| ------ | --------|
+| `crate`      | ✓        | Binary crate name        | string |         |
+| `version`    |          | Crate version to install | string | latest  |
+
+## Security considerations
+
+You should acknowledge that in order to speed up the crates installation,
+this Action uses pre-built binaries stored in the external storage.
+
+Before using this Action consider checking the [Security considerations](https://github.com/actions-rs/tool-cache/blob/master/README.md#security-considerations) chapter
+of the tool cache builder to understand how this might affect you.
+
+## License
+
+This Action is distributed under the terms of the MIT license, see [LICENSE](https://github.com/actions-rs/toolchain/blob/master/LICENSE) for details.
+
+## Contribute and support
+
+Any contributions are welcomed!
+
+If you want to report a bug or have a feature request,
+check the [Contributing guide](https://github.com/actions-rs/.github/blob/master/CONTRIBUTING.md).
+
+You can also support author by funding the ongoing project work,
+see [Sponsoring](https://actions-rs.github.io/#sponsoring).

dist/index.js

@@ -1,7 +1,7 @@
 {
   "name": "rust-cargo-install",
   "version": "0.0.0",
-  "description": "Install a Rust binary as fast as possible",
+  "description": "Install a Rust binary crate as fast as possible",
   "main": "lib/main.js",
   "scripts": {
     "build": "rm -rf ./dist/* && ncc build src/main.ts --minify",
@@ -31,7 +31,8 @@
     "@actions-rs/core": "0.0.9",
     "@actions/core": "^1.2.3",
     "@actions/http-client": "^1.0.6",
-    "@actions/tool-cache": "^1.3.3"
+    "@actions/tool-cache": "^1.3.3",
+    "which": "^2.0.2"
   },
   "devDependencies": {
     "@types/jest": "^25.1.4",

package-lock.json

@@ -32,9 +32,8 @@ function getExt(): string {
 }
 
 async function resolveVersion(crate: string): Promise<string> {
-    // TODO: Better user-agent
     const url = `https://crates.io/api/v1/crates/${crate}`;
-    const client = new http.HttpClient("actions-rs/install");
+    const client = new http.HttpClient("@actions-rs (https://github.com/actions-rs/)");
 
     const resp: any = await client.getJson(url);
     if (resp.result == null) {
@@ -45,6 +44,19 @@ async function resolveVersion(crate: string): Promise<string> {
 }
 
 function buildUrl(crate: string, version: string): string {
+    /**
+     * !!! READ THIS IMPORTANT NOTICE !!!
+     *
+     * In case you want to use that binary cache bucket
+     * for your purposes, please, don't do that.
+     *
+     * It is strictly private and intended to be used
+     * by `@actions-rs` only.
+     * There are no stable folders, naming structure,
+     * bucket name or even the AWS region used.
+     * You are not doing yourself better
+     * by trying to trick everyone, just stop right now.
+     */
     const s3Region = "us-east-2";
     const s3Bucket = "actions-rs.install.binary-cache";
     const runner = getRunner();
@@ -56,6 +68,7 @@ function buildUrl(crate: string, version: string): string {
 function targetPath(crate: string): string {
     const ext = getExt();
     const filename = `${crate}${ext}`;
+
     return path.join(os.homedir(), ".cargo", "bin", filename);
 }
 
@@ -64,16 +77,22 @@ export async function downloadFromCache(
     version: string
 ): Promise<void> {
     if (version == "latest") {
+        core.debug(`Latest version requested for ${crate}, querying crates.io`);
         version = await resolveVersion(crate);
+        core.info(`Newest ${crate} version available at crates.io: ${version}`);
     }
     const url = buildUrl(crate, version);
     const path = targetPath(crate);
 
+    core.debug(`Constructed S3 URL for ${crate}: ${url}`);
+    core.info(`Downloading ${crate} == ${version} into ${path}`);
+
     try {
         await fs.access(path);
 
         core.warning(`Crate ${crate} already exist at ${path}`);
     } catch (error) {
+        core.debug(`Downloading ${url} into ${path}`);
         await tc.downloadTool(url, path);
         await fs.chmod(path, 0o755);
     }