feat: The Great Ennixification #2

srxl · 2025-08-31T07:00:50+02:00

srxl commented

2025-08-31 07:00:50 +02:00

Whew, this is a big one. But, in line with #1, this PR makes the first steps to transition (🏳️‍⚧️) this repo to something that can be consumed through Nix. There's a few things happening in here, so hopefully I've done a good enough job describing it all in the README, and giving an example of it's usage in template.

If you want to test any of this locally, replace the URL for this repo in the setup command and the generated flake's inputs with git+https://codeberg.org/polyphony/workflows?ref=nix. Should work, it's what I've been doing to test anyway.

There's still a few things that need to be tackled:

Actually convert the workflows over. I'm going to hold off on that until polyphony/chorus#631 is good to go, so we can take it's common bits and bring them in here.
Automatic docs.md generation somehow, so we don't need to manually keep it in sync with the modules themselves.

This should be a good start, though. Feel free to hit me with any questions about this one.

Whew, this is a big one. But, in line with #1, this PR makes the first steps to transition (🏳️‍⚧️) this repo to something that can be consumed through Nix. There's a few things happening in here, so hopefully I've done a good enough job describing it all in the README, and giving an example of it's usage in `template`. If you want to test any of this locally, replace the URL for this repo in the setup command and the generated flake's inputs with `git+https://codeberg.org/polyphony/workflows?ref=nix`. Should work, it's what I've been doing to test anyway. There's still a few things that need to be tackled: - Actually convert the workflows over. I'm going to hold off on that until polyphony/chorus#631 is good to go, so we can take it's common bits and bring them in here. - Automatic `docs.md` generation somehow, so we don't need to manually keep it in sync with the modules themselves. This should be a good start, though. Feel free to hit me with any questions about this one.

❤️ 2

srxl added 44 commits

2025-08-31 07:00:51 +02:00

nix: init flake aa2d29dee5

nix: setup nix-direnv 1f80357d70

nix: nixfmt 5f86308411

nix: setup git-hooks 8996f5b41a

nix: setup fenix, add toolchain to devshell b18814acf4

nix: use an overlay to pass around flake inputs with callPackage 9f9d5ba9bf

commit-hooks: use clippy from rust-toolchain 115498072b

nix: setup treefmt 7c887df336

rust: drop rusty-hook in favour of git-hooks.nix 63b83e5c2e

nix: add template definition 9ca16c3628

rust: add basic package info to Cargo.toml daadc2ac19

nix: add welcome text to template 75335aadad

nix: filter some files out of the template a6b05e3e2a

README: document template usage 71a321becc

gitignore: ignore result symlinks created by nix 2be351e623

nix: don't follow nixpkgs for fenix, so it can use nix-community cache 596d40252f

nix: convert flake to use flake-parts 6e330d30c2

nix: split devshell out into module 62dab1dc7e

nix: split git-hooks into module aa830ea934

nix: split treefmt into module 81aefb8dff

modules: add enable option to all modules 2b498dba3c

modules: create rust-toolchain module b7cf93e987

flake: remove unnecessary nixpkgs override 08bb9b4690

flake: export a flake module instead of configuring this flake d43f756627

template: separate into own directory 2de067f2db

module[rust-toolchain]: move hash definitions out of perSystem 9edc63474a

flake: dogfood, with all modules except rustToolchain enabled c71e152e7f

modules: fix breakages when rustToolchain is disabled 4a649fad50

module[git-hooks]: consistent casing 13462c6da7

module[git-hooks]: don't add check when module is disabled 1ad8e24b4d

module[treefmt]: don't add check or formatter when module is disabled 3421bbaf84

modules: format ebed7eb0f5

module[rust]: rename e442473095

module[rust]: create toolchain with fromToolchainFile e4b735db3b

module[rust]: hash doesn't need to be keyed by system c2bde91e35

module[rust]: allow specifying a derivation to build the rust project 8c114149ad

module[rust]: allow specifying cross-compilation targets for rust projects c7f4c9934d

module[rust]: more flexible interface for rust package definitions 1896b3aed7

module[git-hooks]: add treefmt if configured 68523d6ce6

docs: generate docs, include generated version 3be2d723c7

docs: misc improvements 67c105d265

docs: generate links to repo files 4a4a1e9469

README: add more usage documentation 65b937c6d8

docs: generate links to main branch db25bfcf6c

srxl

2025-08-31 07:48:07 +02:00

added the
🏷️Kind
Feature

🏷️Kind
Documentation

Compat
Breaking
labels
requested review from ava

ava commented

2025-08-31 16:24:00 +02:00

I think @alinarielle wanted to review this; I'll leave this open for ~24h (if there is no further response /nm) before I'd review it myself

srxl added 2 commits

2025-09-01 03:11:55 +02:00

docs: only evaluate polyphony options, remove fixupModule ccd457a909

docs: convert to callPackage-style derivation 8ad5ada1d8

srxl added 1 commit

2025-09-01 03:19:18 +02:00

readme: correct toolchain docs 9fc21ef0f4

ava reviewed

2025-09-01 22:13:28 +02:00

docs.md Outdated

					
				@ -0,0 +1,262 @@

				## perSystem\.polyphony\.rust\.package

This file is super, super nice and helpful! I am wondering though: Couldn't this documentation also be inline with the .nix files?

This file is super, super nice and helpful! I am wondering though: Couldn't this documentation also be inline with the `.nix` files?

It actually already is! That docs file is generated from the option definitions in the Nix modules - see this one for an example. The actual bit that generates the docs is here, and you can generate them by running nix build .#docs in the repo. I do need to figure out a good way to automatically do that like I mentioned in the PR message, though.

It actually already is! That docs file is generated from the option definitions in the Nix modules - see [this one](https://codeberg.org/polyphony/workflows/src/branch/nix/modules/rust.nix#L65-L80) for an example. The actual bit that generates the docs is [here](https://codeberg.org/polyphony/workflows/src/branch/nix/packages/docs.nix), and you can generate them by running `nix build .#docs` in the repo. I do need to figure out a good way to automatically do that like I mentioned in the PR message, though.

❤️ 1

That's so cool! Thanks!

ava marked this conversation as resolved

ava approved these changes

2025-09-01 22:15:59 +02:00

Dismissed

ava left a comment

I really like this PR a lot! To be fair, I do not understand the nix parts, but it is beautifully built and documented, and that's pretty amazing! Thank you so much for the effort you have put into this! 💜

srxl commented

2025-09-02 07:27:19 +02:00

Snuck in one last change, and moved devshell options under perSystem, which makes a bit more sense. That way, extraPackages doesn't need to be a function and can just be a plain list, since you have a pkgs set available to you already in perSystem.

Snuck in one last change, and moved devshell options under `perSystem`, which makes a bit more sense. That way, `extraPackages` doesn't need to be a function and can just be a plain list, since you have a `pkgs` set available to you already in `perSystem`.

❤️ 1

srxl force-pushed nix from 840fdc0841 to 900259c34b

2025-09-02 07:29:46 +02:00

Compare

ava approved these changes

2025-09-02 14:41:15 +02:00

ava referenced this pull request from a commit

2025-09-02 14:42:10 +02:00

Merge pull request 'feat: The Great Ennixification' (#2) from nix into main

ava merged commit 776ec5e990 into main

2025-09-02 14:42:16 +02:00

ava deleted branch nix