cargo-tauri.hook: init #335751

getchoo · 2024-08-19T07:41:55Z

Description of changes

With Tauri apps getting more popular and added to nixpkgs, I believe it's time we share the tedious setup required to build them. This PR introduces a new hook in cargo-tauri.hook that builds on top of rustPlatform.buildRustPackage (or more acurately, its hooks) to leverage Tauri's bundling feature in creating packages. It is compatible with the two primary targets we share with Tauri -- Linux and macOS -- and meant to be used alongside pre-existing tools for package managers such as npm, pnpm, and yarn

Supersedes #318117

CC @doronbehar for changes made to yarnConfigHook

Things done

Result of nixpkgs-review run on x86_64-linux 1

5 packages failed to build:

insulator2
kiwitalk
powerdns-admin
surrealist
treedome

24 packages built:

auto-changelog
cargo-tauri
coc-diagnostic
codefresh
diagnostic-languageserver
dotenv-cli
get-graphql-schema
gitbutler
koodo-reader
kuro
listmonk
modrinth-app
modrinth-app-unwrapped
nixpkgs-manual
postlight-parser
pot
screego
spectral-language-server
textlint-rule-prh
vim-language-server
vimPlugins.coc-diagnostic
xplorer
yarnConfigHook
your_spotify

powerdns-admin has been broken since 574c80a

The remaining packages fail with the now infamous

error[E0282]: type annotations needed for Box<_>

Add a 👍 reaction to pull requests you find important.

Eveeifyeve · 2024-08-19T08:11:44Z

I will look into documenting this as this will help build Tauri apps on nix

Eveeifyeve · 2024-08-19T08:12:52Z

And soon bun I am looking to make a hook

doronbehar · 2024-08-19T08:17:46Z

CC @doronbehar for changes made to yarnConfigHook

They seem good. I don't have time unfortunately to review and help with the rest of the PR :/, so I'm unsubscribing myself.

getchoo · 2024-08-19T08:24:21Z

I will look into documenting this as this will help build Tauri apps on nix

I've made a section for it in the manual already here -- it should work for a vast majority of projects. There's also the test-app showing a real world example with one of the upstream templates

happysalada · 2024-08-19T08:56:16Z

Editorconfig check is failing
Ofborg is also failing on insulator2

Apart from that this looks good.

tengkuizdihar · 2024-08-19T10:52:41Z

because of newer rust version, I got an error when testing treedome. I can make a fix and a quick release, can the new release be in this PR?

getchoo · 2024-08-19T10:58:47Z

Editorconfig check is failing

Not really sure what to do there as it's failing due to an icon file

Ofborg is also failing on insulator2

As said in the original comment, this is due to the time crate and unrelated to this PR

because of newer rust version, I got an error when testing treedome. I can make a fix and a quick release, can the new release be in this PR?

Once the update for treedome is merged into master, you can run nixpkgs-review pr 335751 --package treedome and it will automatically merge this PR locally and build treedome. I'll probably end up rebasing on master when I make more changes though, so

philiptaron

The editorconfig CI test giving an error is the canary in the coalmine. nixpkgs should have as little vendored code as possible, and it's quite easy to make a repository for this example app.

pkgs/by-name/ca/cargo-tauri/test-app/.gitignore

Eveeifyeve · 2024-08-21T11:13:33Z

I will look into using this once I have a bun install/config hook.

getchoo · 2024-08-23T04:42:09Z

Fixed merge conflict with #335795. Treedome should build now

philiptaron

I'm out of my depth on the actual content of this PR (the hook creation and use). I do like this PR and hope to learn more.

Here's a review of the content as I read through it this morning.

doc/hooks/tauri.section.md

pkgs/by-name/ca/cargo-tauri/package.nix

pkgs/by-name/ca/cargo-tauri/test-app.nix

pkgs/by-name/ki/kiwitalk/package.nix

philiptaron · 2024-09-03T16:37:04Z

pkgs/by-name/ca/cargo-tauri/hook.sh

+        # Tauri doesn't respect $CARGO_TARGET_DIR, but does respect the cargo
+        # argument...but that doesn't respect `--target`, so we have to use the
+        # config file
+        # https://github.com/tauri-apps/tauri/issues/10190


[bug] Using "--target-dir" with tauri build causes "failed to rename app: failed to rename" tauri-apps/tauri#10190

Closed as "completed" on July 10th 👀

Yep, --target-dir is respected now. What I'm trying to explain here though is that when it's used alongside the target --target argument, it still tries to use target/<release type> as the target directory even though cargo will actually output to target/<target triple>/<release type>

I should probably make a patch/issue for this at some point, I just haven't had the time lol

pkgs/by-name/ca/cargo-tauri/hook.sh

philiptaron · 2024-09-03T16:44:47Z

pkgs/by-name/ca/cargo-tauri/hook.sh

@@ -0,0 +1,125 @@
+# shellcheck shell=bash


CC @tie for bash review (I'm slowly building my skills but they are a master)

MDM23 · 2024-09-03T19:07:25Z

I'm currently updating surrealist to the latest version, which requires cargo-tauri v2. Do you see any way to have v1 and v2 as top-level packages with the new hook?

Initially, I just overwrote it locally:

https://github.com/NixOS/nixpkgs/pull/335619/files#diff-7593db6b9b5b36a086f481cfdce0d8629e002817795794ab40592d321f2e93c2R27

nyabinary · 2024-09-05T17:08:11Z

Shouldn't this be fixed as well? tauri-apps/tauri#8679

getchoo · 2024-09-05T17:27:57Z

Shouldn't this be fixed as well? tauri-apps/tauri#8679

I think that would be something more for upstream, as the only way we can "fix" this is by applying the patch linked in the issue to each package. I wouldn't consider that in scope for this PR though, and probably not a good idea to do across the board as messing with vendored deps should generally be avoided. For packages that need the patch, they should be able to use it in crateOverrides similar to any other Rust package

philiptaron · 2024-09-06T21:34:02Z

Looks like #335619 sniped you. Mind rebasing?

Eveeifyeve · 2024-09-07T22:20:48Z

also we should make this a generic or something as there is dev version of cargo tauri cli.

Eveeifyeve · 2024-09-07T22:21:10Z

And we should start supporting it as it's in rc.

getchoo · 2024-09-08T02:09:47Z

also we should make this a generic or something as there is dev version of cargo tauri cli.

Not sure how well that would work given the breaking changes now (and possibly in the future) in Tauri v2 from v1. I would consider these hooks to be pretty flexible though, so if there aren't that many breaking changes related to the build I doubt it would be hard to implement

And we should start supporting it as it's in rc.

That would be best in another PR

nyabinary · 2024-09-08T13:43:36Z

also we should make this a generic or something as there is dev version of cargo tauri cli.

Not sure how well that would work given the breaking changes now (and possibly in the future) in Tauri v2 from v1. I would consider these hooks to be pretty flexible though, so if there aren't that many breaking changes related to the build I doubt it would be hard to implement

And we should start supporting it as it's in rc.

That would be best in another PR

https://v2.tauri.app/blog/tauri-2-0-0-release-candidate/
https://v2.tauri.app/blog/roadmap-to-tauri-2-0/

There won't be any breaking changes in RC according to this so I think it's best to do it in this pr tbh

getchoo · 2024-09-08T18:58:35Z

There won't be any breaking changes in RC

I'm talking about the breaking changes from Tauri v1 -> Tauri v2, not breaking changes from the v2 RC to stable

so I think it's best to do it in this pr tbh

Setting up the v2 packaging here initially is definitely out of scope IMO given how large this PR already is. The hooks created here will -- at the very least -- require changes to most dependencies like using GTK4 over 3, a newer webkitgtk ABI, etc. I think it would be much better to make those changes later on once we get this merged and actually package v2

philiptaron · 2024-09-10T23:06:32Z

@getchoo -- please make sure to integrate the changes from #340862 when you fix the merge conflict.

Specifically: - Tighten dependencies by only listing what's needed to build - Better sorting things - Adding `meta.changelog`

getchoo requested a review from philiptaron as a code owner August 19, 2024 07:41

github-actions bot added 6.topic: nixos 8.has: documentation 8.has: changelog 6.topic: nodejs labels Aug 19, 2024

doronbehar mentioned this pull request Aug 19, 2024

yarnInstallHook: init #328544

Merged

13 tasks

ofborg bot requested review from linsui, happysalada, dit7ya, honnip, MDM23, tc-kaluza, techknowlogick and tengkuizdihar August 19, 2024 08:14

ofborg bot added 10.rebuild-darwin: 11-100 10.rebuild-linux: 11-100 labels Aug 19, 2024

tengkuizdihar mentioned this pull request Aug 19, 2024

treedome: 0.4.5 -> 0.5.1 #335795

Merged

13 tasks

philiptaron previously requested changes Aug 20, 2024

View reviewed changes

pkgs/by-name/ca/cargo-tauri/test-app/.gitignore Outdated Show resolved Hide resolved

getchoo force-pushed the pkgs/tauriBuildHook/init branch from aa6497a to 3b40326 Compare August 20, 2024 22:58

getchoo requested a review from philiptaron August 20, 2024 22:59

getchoo force-pushed the pkgs/tauriBuildHook/init branch from 3b40326 to 4ada60a Compare August 23, 2024 04:41

philiptaron reviewed Sep 3, 2024

View reviewed changes

getchoo force-pushed the pkgs/tauriBuildHook/init branch from d88a68a to f85bef5 Compare September 6, 2024 01:43

wegank added the 2.status: merge conflict label Sep 10, 2024

getchoo added 14 commits September 12, 2024 00:32

cargo-tauri: migrate to by-name

21d55b9

cargo-tauri: refactor

7617f0a

Specifically: - Tighten dependencies by only listing what's needed to build - Better sorting things - Adding `meta.changelog`

cargo-tauri: add getchoo as a maintainer

67335e1

cargo-tauri.hook: init

6cab829

cargo-tauri: add test for setup hooks

e8b6b51

doc: init tauri hook section

ace4c85

modrinth-app: use cargo-tauri.hook

7dd88ed

cinny-desktop: use cargo-tauri.hook

a316bd5

gitbutler: use cargo-tauri.hook

3aabf00

pot: use cargo-tauri.hook

d77fa1e

surrealist: use cargo-tauri.hook

7e56179

kiwitalk: use cargo-tauri.hook

4dc8ac1

insulator2: use cargo-tauri.hook & yarnConfigHook

d90ecf8

doc/release-notes: add section on cargo-tauri.hook

993d64b

getchoo force-pushed the pkgs/tauriBuildHook/init branch from f85bef5 to 993d64b Compare September 12, 2024 05:21

getchoo removed the 2.status: merge conflict label Sep 12, 2024

getchoo mentioned this pull request Sep 12, 2024

modrinth-app-unwrapped: refactor and use pnpm hooks #341085

Closed

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cargo-tauri.hook: init #335751

cargo-tauri.hook: init #335751

getchoo commented Aug 19, 2024

Eveeifyeve commented Aug 19, 2024 •

edited

Loading

Eveeifyeve commented Aug 19, 2024

doronbehar commented Aug 19, 2024

getchoo commented Aug 19, 2024

happysalada commented Aug 19, 2024

tengkuizdihar commented Aug 19, 2024

getchoo commented Aug 19, 2024

philiptaron left a comment

Eveeifyeve commented Aug 21, 2024

getchoo commented Aug 23, 2024

philiptaron left a comment

philiptaron Sep 3, 2024

getchoo Sep 5, 2024

philiptaron Sep 3, 2024

MDM23 commented Sep 3, 2024

nyabinary commented Sep 5, 2024 •

edited

Loading

getchoo commented Sep 5, 2024

philiptaron commented Sep 6, 2024 •

edited

Loading

Eveeifyeve commented Sep 7, 2024

Eveeifyeve commented Sep 7, 2024

getchoo commented Sep 8, 2024

nyabinary commented Sep 8, 2024 •

edited

Loading

getchoo commented Sep 8, 2024

philiptaron commented Sep 10, 2024

cargo-tauri.hook: init #335751

Are you sure you want to change the base?

cargo-tauri.hook: init #335751

Conversation

getchoo commented Aug 19, 2024

Description of changes

Things done

Eveeifyeve commented Aug 19, 2024 • edited Loading

Eveeifyeve commented Aug 19, 2024

doronbehar commented Aug 19, 2024

getchoo commented Aug 19, 2024

happysalada commented Aug 19, 2024

tengkuizdihar commented Aug 19, 2024

getchoo commented Aug 19, 2024

philiptaron left a comment

Choose a reason for hiding this comment

Eveeifyeve commented Aug 21, 2024

getchoo commented Aug 23, 2024

philiptaron left a comment

Choose a reason for hiding this comment

philiptaron Sep 3, 2024

Choose a reason for hiding this comment

getchoo Sep 5, 2024

Choose a reason for hiding this comment

philiptaron Sep 3, 2024

Choose a reason for hiding this comment

MDM23 commented Sep 3, 2024

nyabinary commented Sep 5, 2024 • edited Loading

getchoo commented Sep 5, 2024

philiptaron commented Sep 6, 2024 • edited Loading

Eveeifyeve commented Sep 7, 2024

Eveeifyeve commented Sep 7, 2024

getchoo commented Sep 8, 2024

nyabinary commented Sep 8, 2024 • edited Loading

getchoo commented Sep 8, 2024

philiptaron commented Sep 10, 2024

Eveeifyeve commented Aug 19, 2024 •

edited

Loading

nyabinary commented Sep 5, 2024 •

edited

Loading

philiptaron commented Sep 6, 2024 •

edited

Loading

nyabinary commented Sep 8, 2024 •

edited

Loading