instant-scala: init at 0.1.0 #337451

jatcwang · 2024-08-26T11:43:47Z

Description of changes

Add instant-scala (https://github.com/jatcwang/instant-scala), a wrapper script around scala-cli/GraalVM which allow writing scala scripts that starts instantly.

Things done

Add a 👍 reaction to pull requests you find important.

Bot-wxt1221

Rename your PR title to: instant-scale: init at 0.1.0.

Move the package to pkgs/by-name. We are currently moving all package in pkgs/top-level/all-packages.nix to pkgs/by-name

pkgs/development/tools/misc/instant-scala/default.nix

Bot-wxt1221 · 2024-09-04T12:35:23Z

pkgs/development/tools/misc/instant-scala/default.nix

+    sha256 = "jqSvKTL8NzqjwqDj/+55YWecx2bnzuArP8RdfH5q/1U=";
+  };
+
+  propagateBuildInputs = [


Why use propagateBuildInputs.

The idea is that any downsteram packages (if any) that uses instant-scala will require bash & scala-cli to run anyway.

(If I'm understanding it right.. Basing my interpretation off https://gist.github.com/CMCDragonkai/45359ee894bc0c7f90d562c4841117b5)

I have changed it to buildInputs for now but keen to learn which way is correct based on what this script (instant-scala) is doing.

Well, first of all, it should be propagatedBuildInputs, so I don't believe this is doing anything but defining a list that is not used?

propagatedBuildInputs is only for buildInputs that have to be "on the PATH" during a build of something that depends on your derivation. Instead you should patch the script, with patchShebangs and/or manually so that that is not necessary.

Bot-wxt1221 · 2024-09-04T12:38:05Z

pkgs/development/tools/misc/instant-scala/default.nix

+
+  propagateBuildInputs = [
+    pkgs.bash
+    pkgs.scala-cli


Will this work?

jatcwang · 2024-09-12T09:47:04Z

Thanks a lot for the thorough review @Bot-wxt1221! I'll check and get them fixed as soon as I got time.

Bot-wxt1221 · 2024-09-12T22:56:28Z

pkgs/by-name/in/instant-scala/package.nix

+  src = fetchFromGitHub {
+    owner = "jatcwang";
+    repo = "instant-scala";
+    rev = "/refs/tags/v${finalAttrs.version}";


Suggested change

rev = "/refs/tags/v${finalAttrs.version}";

rev = "refs/tags/v${finalAttrs.version}";

Not fixed actually

Bot-wxt1221 · 2024-09-12T22:56:51Z

pkgs/by-name/in/instant-scala/package.nix

+  };
+
+  buildInputs = with pkgs; [
+    bash


I mean that bash is included by default.

I see I didn't know that. Removed

Bot-wxt1221 · 2024-09-12T22:57:40Z

pkgs/by-name/in/instant-scala/package.nix

+  lib,
+  stdenv,
+  fetchFromGitHub,
+  pkgs,


Do not include the hole pkgs. just include the package you used like scale-cli.

Bot-wxt1221 · 2024-09-12T23:00:50Z

pkgs/by-name/in/instant-scala/package.nix

+    mkdir -p $out/bin
+    cp ${finalAttrs.pname} $out/bin/${finalAttrs.pname}
+    chmod +x $out/bin/${finalAttrs.pname}


Suggested change

mkdir -p $out/bin

cp ${finalAttrs.pname} $out/bin/${finalAttrs.pname}

chmod +x $out/bin/${finalAttrs.pname}

install -Dm755 instant-scala $out/bin/instant-scala

Avoid using finalAttrs.pname as program name because people may override the pname.

That makes sense. What should I use instead? Sorry I'm not familiar with latest best practices.
I found #310373 but it doesn't seem obvious to me what I should use.
The official doc https://nixos.org/manual/nixpkgs/stable/ is using rec 🫨

Just use instant-scala. Don't use pname as the name of binary.

Sure I can do that. What about version?
(I'm trying to learn what the best practice is - if I do want to reuse variables but still allow downstream to override)

That's OK. The reason why don't use pname is for override. If we override pname. Build will fail.

Bot-wxt1221 · 2024-09-12T23:01:04Z

pkgs/by-name/in/instant-scala/package.nix

+    homepage = "https://github.com/jatcwang/${finalAttrs.pname}";
+    license = lib.licenses.asl20;
+    maintainers = [ lib.maintainer.jatcwang ];
+    mainProgram = finalAttrs.pname;


Same as above.

Bot-wxt1221

Will this really work?

Bot-wxt1221

I don't know will darwin work for this installPhase.

Bot-wxt1221 · 2024-09-16T23:30:06Z

pkgs/by-name/in/instant-scala/package.nix

+  src = fetchFromGitHub {
+    owner = "jatcwang";
+    repo = "instant-scala";
+    rev = "/refs/tags/v${finalAttrs.version}";


Not fixed actually

Bot-wxt1221 · 2024-09-16T23:31:01Z

pkgs/by-name/in/instant-scala/package.nix

+    mkdir -p $out/bin
+    cp instant-scala $out/bin/instant-scala
+    chmod +x $out/bin/instant-scala


Use install instead.

Use install instead.

Sorry, my metallic friend. You'd use install if there was an installer script or makefile, but the repo has a plain bash script. The install phase, as written, looks correct.

From the manual:
"The default installPhase creates the directory $out and calls make install"

Since there's no makefile, creating $out and copying appropriately is the right answer.

Bot-wxt1221 is right, use install -Dm755 instant-scala -t $out/bin instead.

@Bot-wxt1221 my apologies. TIL.

sarahec · 2024-09-17T02:22:21Z

Please fix the title of this PR -- it should be instant-scala instead of scalE

sarahec · 2024-09-17T02:24:43Z

maintainers/maintainer-list.nix

+  jatcwang = {
+    email = "[email protected]";
+    github = "jatcwang";
+    githubId = 4957161;
+    name = "Jacob Wang";
+  };


This is normally done as its own commit titledmaintainers: add jatcwang

sarahec · 2024-09-17T02:26:43Z

pkgs/by-name/in/instant-scala/package.nix

+    description = "Write Scala scripts that starts instantly using scala-cli and GraalVM";
+    homepage = "https://github.com/jatcwang/instant-scala";
+    license = lib.licenses.asl20;
+    maintainers = [ lib.maintainer.jatcwang ];


Suggested change

maintainers = [ lib.maintainer.jatcwang ];

maintainers = with lib.maintainers; [ jatcwang ];

Causes a build failure that keeps me from testing the Darwin build. Sorry.

sarahec · 2024-09-17T02:28:47Z

pkgs/by-name/in/instant-scala/package.nix

+    license = lib.licenses.asl20;
+    maintainers = [ lib.maintainer.jatcwang ];
+    mainProgram = "instant-scala";
+    platforms = lib.platforms.unix;


Suggested change

platforms = lib.platforms.unix;

Not needed, should be fine on all platforms that run Scala.

Bot-wxt1221 · 2024-09-18T09:20:09Z

Rename your second commit message to instant-scala: init at 0.1.0

Bot-wxt1221 · 2024-09-18T09:20:54Z

pkgs/by-name/in/instant-scala/package.nix

+
+  meta = {
+    description = "Write Scala scripts that starts instantly using scala-cli and GraalVM";
+    homepage = "https://github.com/jatcwang/instant-scala";


miss changelog here.

Fixed sorry

Bot-wxt1221

LGTM

sarahec · 2024-09-18T15:47:30Z

pkgs/by-name/in/instant-scala/package.nix

+  meta = {
+    description = "Write Scala scripts that starts instantly using scala-cli and GraalVM";
+    homepage = "https://github.com/jatcwang/instant-scala";
+    changelog = "https://github.com/jatcwang/instant-scala/releases";


Suggested change

changelog = "https://github.com/jatcwang/instant-scala/releases";

changelog = "https://github.com/jatcwang/instant-scala/releases/v${finalAttrs.version}";

Done thanks

sarahec · 2024-09-18T17:18:12Z

pkgs/by-name/in/instant-scala/package.nix

+  meta = {
+    description = "Write Scala scripts that starts instantly using scala-cli and GraalVM";
+    homepage = "https://github.com/jatcwang/instant-scala";
+    changelog = "https://github.com/jatcwang/instant-scala/releases/${finalAttrs.version}";


Suggested change

changelog = "https://github.com/jatcwang/instant-scala/releases/${finalAttrs.version}";

changelog = "https://github.com/jatcwang/instant-scala/releases/v${finalAttrs.version}";

sarahec · 2024-09-18T19:52:17Z

Result of nixpkgs-review pr 337451 run on x86_64-linux 1

1 package built:

instant-scala

sarahec

LGTM

sarahec · 2024-09-18T19:53:50Z

Result of nixpkgs-review pr 337451 run on aarch64-darwin 1

1 package built:

instant-scala

github-actions bot added the 8.has: maintainer-list (update) label Aug 26, 2024

NixOSInfra added the 12. first-time contribution label Aug 26, 2024

Bot-wxt1221 reviewed Sep 4, 2024

View reviewed changes

Bot-wxt1221 suggested changes Sep 4, 2024

View reviewed changes

pkgs/development/tools/misc/instant-scala/default.nix Outdated

propagateBuildInputs = [

pkgs.bash

pkgs.scala-cli

Copy link

Member

Bot-wxt1221 Sep 4, 2024

Choose a reason for hiding this comment

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

Will this work?

jatcwang changed the title ~~Add package instant-scala~~ instant-scale: init at 0.1.0 Sep 12, 2024

jatcwang force-pushed the master branch 3 times, most recently from 52c2d14 to b363720 Compare September 12, 2024 20:29

Bot-wxt1221 approved these changes Sep 12, 2024

View reviewed changes

Bot-wxt1221 self-requested a review September 12, 2024 23:02

Bot-wxt1221 reviewed Sep 12, 2024

View reviewed changes

jatcwang force-pushed the master branch from b363720 to 06fb967 Compare September 16, 2024 20:45

Bot-wxt1221 reviewed Sep 16, 2024

View reviewed changes

Bot-wxt1221 requested a review from a team September 16, 2024 23:31

sarahec reviewed Sep 17, 2024

View reviewed changes

jatcwang changed the title ~~instant-scale: init at 0.1.0~~ instant-scala: init at 0.1.0 Sep 18, 2024

maintainers: add jatcwang

9710ff0

jatcwang force-pushed the master branch from 06fb967 to 1d5ebb8 Compare September 18, 2024 08:36

Bot-wxt1221 reviewed Sep 18, 2024

View reviewed changes

jatcwang force-pushed the master branch from 1d5ebb8 to 9758874 Compare September 18, 2024 09:23

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Sep 18, 2024

ofborg bot added the 10.rebuild-linux: 1 label Sep 18, 2024

Bot-wxt1221 approved these changes Sep 18, 2024

View reviewed changes

Bot-wxt1221 added the 12.approvals: 1 label Sep 18, 2024

sarahec reviewed Sep 18, 2024

View reviewed changes

jatcwang force-pushed the master branch from 9758874 to 5b0e0ce Compare September 18, 2024 15:55

wegank removed the 12.approvals: 1 label Sep 18, 2024

sarahec suggested changes Sep 18, 2024

View reviewed changes

instant-scala: init at 0.1.0

914c72c

jatcwang force-pushed the master branch from 5b0e0ce to 914c72c Compare September 18, 2024 18:42

sarahec approved these changes Sep 18, 2024

View reviewed changes

sarahec added the 12.approvals: 1 label Sep 18, 2024

wegank added 12.approvals: 2 and removed 12.approvals: 1 labels Sep 19, 2024

	rev = "/refs/tags/v${finalAttrs.version}";
	rev = "refs/tags/v${finalAttrs.version}";

	maintainers = [ lib.maintainer.jatcwang ];
	maintainers = with lib.maintainers; [ jatcwang ];

	changelog = "https://github.com/jatcwang/instant-scala/releases";
	changelog = "https://github.com/jatcwang/instant-scala/releases/v${finalAttrs.version}";

instant-scala: init at 0.1.0 #337451

Are you sure you want to change the base?

instant-scala: init at 0.1.0 #337451

Conversation

jatcwang commented Aug 26, 2024

Description of changes

Things done

Bot-wxt1221 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jatcwang Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jatcwang commented Sep 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bot-wxt1221 Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bot-wxt1221 left a comment

Choose a reason for hiding this comment

Bot-wxt1221 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sarahec Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

sikmir Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sarahec commented Sep 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bot-wxt1221 commented Sep 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bot-wxt1221 left a comment

Choose a reason for hiding this comment

sarahec Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sarahec commented Sep 18, 2024

sarahec left a comment

Choose a reason for hiding this comment

sarahec commented Sep 18, 2024

jatcwang Sep 12, 2024 •

edited

Loading

Bot-wxt1221 Sep 13, 2024 •

edited

Loading

sarahec Sep 17, 2024 •

edited

Loading

sikmir Sep 17, 2024 •

edited

Loading

sarahec Sep 18, 2024 •

edited

Loading