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

Use GitHub Actions cache for installed binaries #5

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Use GitHub Actions cache for installed binaries #5

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
40cec18
Use GitHub Actions cache for installed binaries
flip1995 Jun 25, 2020
981bb2e
Use resolveVersion from actions-rs/core
flip1995 Jun 25, 2020
0d51c02
Update package{-lock}.json
flip1995 Aug 6, 2020
9f5d8b9
Update dist/index.js
flip1995 Aug 7, 2020
57e52b9
WIP: Remove key arguments of actions
flip1995 Sep 10, 2020
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
8 changes: 5 additions & 3 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ inputs:
description: Use tool cache to speed up installation
required: false
default: false
use-cache:
description: Store installed binary in the GitHub Actions cache (not used yet)
key:
description: Store installed binary in the GitHub Actions cache with the specified key
required: false
restore-keys:
description: Restore keys as used in the GitHub cache action
required: false
default: true

runs:
using: 'node12'
Expand Down
16 changes: 1 addition & 15 deletions src/download.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ import os from "os";
import { promises as fs } from "fs";
import path from "path";

import { resolveVersion } from "@actions-rs/core";
import * as core from "@actions/core";
import * as exec from "@actions/exec";
import * as tc from "@actions/tool-cache";
import * as http from "@actions/http-client";

const CLOUDFRONT_ROOT = "https://d1ad61wkrfbmp3.cloudfront.net";
// Path to the public key of the sign certificate.
Expand All @@ -32,20 +32,6 @@ function getRunner(): string {
}
}

async function resolveVersion(crate: string): Promise<string> {
const url = `https://crates.io/api/v1/crates/${crate}`;
const client = new http.HttpClient(
"@actions-rs (https://github.com/actions-rs/)"
);

const resp: any = await client.getJson(url);
if (resp.result == null) {
throw new Error("Unable to fetch latest crate version");
}

return resp.result["crate"]["newest_version"];
}

function buildUrl(crate: string, version: string): string {
const runner = getRunner();

Expand Down
9 changes: 6 additions & 3 deletions src/input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,22 @@ export interface Input {
crate: string;
version: string;
useToolCache: boolean;
useCache: boolean;
primaryKey?: string;
restoreKeys?: string[];
}

export function get(): Input {
const crate = input.getInput("crate", { required: true });
const version = input.getInput("version", { required: true });
const useToolCache = input.getInputBool("use-tool-cache") || false;
const useCache = input.getInputBool("use-cache") || true;
const primaryKey = input.getInput("key") || undefined;
const restoreKeys = input.getInputAsArray("restore-keys") || undefined;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is a good idea to force users to provide all necessary cache keys, as Action can do that by itself; grab the crate name, version and current runner name (ex. ubuntu-18.04), join them together - we got a cache key.
That also mean that we will need to use resolveVersion if there is no version specifically set in the Action arguments or set to "latest", for example.

Ideally, from the user side I would expect to write

- uses: actions-rs/[email protected]
  with:
    crate: cargo-make

and it will handle all the stuff by itself.

Copy link
Author

@flip1995 flip1995 Aug 16, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My thought behind adding those keys was that there is currently no way to force-update a cache. If a new cache should be created, the cache has to get a new name. With actions/cache in rust projects, this is for example done by hashing the Cargo.lock files.

But when caching binaries I guess only naming the hash with the version number should do the trick. There should be no need to add a hash to the cache name.

Should I remove the keys completely or should I just make them optional?

The part with resolving the version is already implemented. But I still have to add the runner name.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@svartalf Do you have a suggestion how I might get the name of the runner? I looked at the @actions/github and @actions/core package, but couldn't find any functions with which I'm able to access the runner name.

If we're able to get the runner name $somehow, we can get rid of the key/restoreKeys arguments of the action and go back to useCache. This change has to be implemented in actions-rs/core though.


return {
crate: crate,
version: version,
useToolCache: useToolCache,
useCache: useCache,
primaryKey: primaryKey,
restoreKeys: restoreKeys,
};
}
13 changes: 10 additions & 3 deletions src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import * as download from "./download";

interface Options {
useToolCache: boolean;
useCache: boolean;
primaryKey?: string;
restoreKeys?: string[];
}

async function downloadFromToolCache(
Expand Down Expand Up @@ -52,7 +53,12 @@ export async function run(
} catch (error) {
core.info("Falling back to the `cargo install` command");
const cargo = await Cargo.get();
await cargo.installCached(crate, version);
await cargo.installCached(
crate,
version,
options.primaryKey,
options.restoreKeys
);
}
}

Expand All @@ -62,7 +68,8 @@ async function main(): Promise<void> {

await run(actionInput.crate, actionInput.version, {
useToolCache: actionInput.useToolCache,
useCache: actionInput.useCache,
primaryKey: actionInput.primaryKey,
restoreKeys: actionInput.restoreKeys,
});
} catch (error) {
core.setFailed(error.message);
Expand Down