No simple template with a proper build / dependency example
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- build-system
Research direction
Start by inspecting the existing defaultTemplate, templates#trivial, simpleContainer, bash-hello, rust-web-server, and compat templates. Add a small flake template demonstrating a development environment and a simple Makefile build for a non-Nix project, with dependencies visible and instructions sufficient to use nix develop.
Written by the indexing model from the issue text.
Description
The templates feature for nix flake seems like a great opportunity to offer easy-setup build environments, particularly for individuals working on non-nix projects and just getting started.
One template I was unable to find was a simple example that's sufficient for nix develop and a simple Makefile build. That is, a template that might serve as a replacement for a simple default.nix / shell.nix, but follow the new flake pattern
with (import <nixpkgs> {});
stdenv.mkDerivation {
name = "foo";
buildInputs = [ ... ];
}
But the defaultTemplate and templates#trivial both just build an existing package, without any clarity as to build inputs / dev environment.
On the other hand, there are examples like simpleContainer, bash-hello, and rust-web-server are comparatively large, including nixos modules, VM tests, system compatibility, and other features.
Compat creates legacy default.nix/shell.nix files but doesn't show a fresh flake.nix
Can a template be added for a small reasonable build, such as for building a project which was not originally developed using nixpkgs? Possibly for a particular language like C but which in that case could be readily adapted
- Dominant language
- Nix
- Stars
- 768
- Forks
- 104
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from NixOS/templates
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
[Rust template] Clang errorPossibly taken @tomberek claimed this 53 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
Similar issues
-
ci enhancement tooling
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
A second build without clean fails in resources-optimizer-maven-plugin because minified files are minified againPossibly taken @papegaaij claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
type: dependency-upgrade
Difficulty 1/5 Under an hour Newbie friendliness 76/100
spring-projects/spring-security#20057 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
gavinlouuu-kpt/mib-studio-qt#903 ·
Maintainers usually reply within 1 day
-
Build produces empty forge.min.js: package.json lists "forge" instead of "node-forge"Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100