Typescript rewrite #34

Hoverbear · 2023-07-11T17:34:49Z

Description

Port the action to typescript!

This will let us avoid having bash in this part of the codebase. It also gives us the space to add some more intelligence to the action eg richer logging: https://www.npmjs.com/package/@actions/core

This is a fairly basic and direct port, more a starting point than any added features.

Checklist

Tested changes against a test repository
Added or updated relevant documentation (leave unchecked if not applicable)
(If this PR is for a release) Updated README to point to the new tag (leave unchecked if not applicable)

…ypescript

action.yml

Hoverbear · 2023-07-13T17:23:30Z

(I invited some testers via social media, not going to merge this for a day at least)

src/main.ts

cole-h · 2023-07-13T17:39:34Z

src/main.ts

+      args.concat(extra_args);
+    }
+
+    const merged_env = {


I wonder how this behaves in the case where a user specifies env: NIX_INSTALLER_EXTRA_CONF: "asdf" and with: extra-conf: "foo"... Will it choose the input over the env, or error because there are two envs with the same name but conflicting values?

In theory a user could not modify the env provided to the javascript!

I meant providing both an env: and a with: to the action that touch the same options. But I don't think it's worth being super defensive about until we see issues about it.

Ahhh ya, fair.

cole-h · 2023-07-13T17:43:37Z

src/main.ts

+    // Normal just doing of the install
+    const binary_path = await this.fetch_binary();
+    await this.execute_install(binary_path);
+    // TODO: Add `this.set_github_path()` and remove that from the installer crate


Looks to me like the first part of this was done (I see a this.set_github_path(); above :D)

Ya I need to make the other side of this, let me cook a PR.

DeterminateSystems/nix-installer#568

src/main.ts

Hoverbear · 2023-07-14T16:16:33Z

Added some handling of if $GITHUB_PATH has already been written (by the installer running as root) so this won't need tight version cadence.

Hoverbear · 2023-07-14T16:57:32Z

There is a bit of a complication here:

We release a new version of this action which does the GITHUB_PATH update
We release a version of nix-installer in the future which does not do the update
Folks running the old version of the nix-installer-action have their CI break because their action isn't doing the GITHUB_PATH update.

We'll need a transitionary period where we have GITHUB_PATH being set in both places, and monitor for use of our old versions for a bit. After a few versions (and no public repos using the old action version) we can remove the old GITHUB_PATH code.

I think in the meantime we should have the nix-installer output a warning to update the nix-installer-action if it detects it's in CI.

cole-h

Looking good!

Hoverbear · 2023-07-14T19:31:45Z

I think it should gracefully handle #34 (comment) now.

Hoverbear self-assigned this Jul 11, 2023

Typescript rewrite

79baecf

Hoverbear force-pushed the hoverbear/ds-893-make-installer-action-use-typescript branch from c52aeb1 to 79baecf Compare July 11, 2023 17:36

Hoverbear added 6 commits July 11, 2023 10:40

Merge branch 'main' into hoverbear/ds-893-make-installer-action-use-t…

74554e4

…ypescript

Add extra_conf, reinstall

8e89511

Info log

339fb79

Tidy up logging

3bae1cc

Trim logging and encode stdout/stderr

35759c8

Refine trimming a bit

8910100

This was referenced Jul 12, 2023

Test Typescript rewrite DeterminateSystems/nix-installer-example#10

Closed

Test DS 893: Typescript rewrite of Action DeterminateSystems/nix-installer#563

Closed

Add logging directives

195f007

Hoverbear force-pushed the hoverbear/ds-893-make-installer-action-use-typescript branch from bfa0bb0 to 195f007 Compare July 13, 2023 15:14

Hoverbear mentioned this pull request Jul 13, 2023

Fix specifying a custom planner #35

Merged

3 tasks

Hoverbear added 2 commits July 13, 2023 10:11

Use less esoteric formatting settings

5eda0a4

Merge branch 'main' into hoverbear/ds-893-make-installer-action-use-t…

20c8a30

…ypescript

Hoverbear marked this pull request as ready for review July 13, 2023 17:13

Hoverbear requested a review from cole-h July 13, 2023 17:16