From 33206b5b86f567de9db72b7bf55ea8ff8adf0cfc Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:50:15 -0500 Subject: [PATCH 1/9] Update yaml-options.md Explicit instructions for what to do if you have an out of date dependency --- docs/reference/yaml-options.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index de00c91cd..43b0582e5 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -53,3 +53,25 @@ imports: !!! note "Added in 1.0" - relative file support in imports: `./mymodule.nix` + +### What to do if your package is out of date? + - Find the email of the maintainers, found on the Nix packages website + - Kindly ask them how you can help upgrade, either they will do it or you can do it yourself + - Make a PR, get the URL of the patch + - It will take the form of 'github:$GH_USERNAME/nixpkgs/master' + - Add it to your devenv.yaml like so + +#### This is an example of a rust project that needs a new dependency + +```yaml +inputs: + nixpkgs: + url: 'github:taylor1791/nixpkgs/master' + fenix: + url: 'github:nix-community/fenix' + inputs: + nixpkgs: + follows: nixpkgs +``` + + From bcfa1568dc99472acd38411ad9d75f8cfad38f0c Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:43:24 -0500 Subject: [PATCH 2/9] Update docs/reference/yaml-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Domen Kožar --- docs/reference/yaml-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index 43b0582e5..20a3e60f5 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -55,7 +55,7 @@ imports: - relative file support in imports: `./mymodule.nix` ### What to do if your package is out of date? - - Find the email of the maintainers, found on the Nix packages website + - Open [nixpkgs repo](https://github.com/NixOS/nixpkgs) and press `t` to search for your package. - Kindly ask them how you can help upgrade, either they will do it or you can do it yourself - Make a PR, get the URL of the patch - It will take the form of 'github:$GH_USERNAME/nixpkgs/master' From a97e130ecec6562d41b8d0f4399bc769973096db Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:43:33 -0500 Subject: [PATCH 3/9] Update docs/reference/yaml-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Domen Kožar --- docs/reference/yaml-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index 20a3e60f5..351db24b3 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -54,7 +54,7 @@ imports: - relative file support in imports: `./mymodule.nix` -### What to do if your package is out of date? +### What if a package is out of date? - Open [nixpkgs repo](https://github.com/NixOS/nixpkgs) and press `t` to search for your package. - Kindly ask them how you can help upgrade, either they will do it or you can do it yourself - Make a PR, get the URL of the patch From 89339bdd0b6584c59d9e7d09a2ba3901564eca8d Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:43:44 -0500 Subject: [PATCH 4/9] Update docs/reference/yaml-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Domen Kožar --- docs/reference/yaml-options.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index 351db24b3..ce14d4367 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -61,7 +61,6 @@ imports: - It will take the form of 'github:$GH_USERNAME/nixpkgs/master' - Add it to your devenv.yaml like so -#### This is an example of a rust project that needs a new dependency ```yaml inputs: From 1fc2cb22d66c8ac89fca3b388b066db7d94af4d8 Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:43:57 -0500 Subject: [PATCH 5/9] Update docs/reference/yaml-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Domen Kožar --- docs/reference/yaml-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index ce14d4367..327b88422 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -56,7 +56,7 @@ imports: ### What if a package is out of date? - Open [nixpkgs repo](https://github.com/NixOS/nixpkgs) and press `t` to search for your package. - - Kindly ask them how you can help upgrade, either they will do it or you can do it yourself + - Try to update/change the package using [the nixpkgs contributing guide](https://nixos.org/manual/nixpkgs/stable/#chap-quick-start), optionally contacting the maintainer for help if you get stuck. - Make a PR, get the URL of the patch - It will take the form of 'github:$GH_USERNAME/nixpkgs/master' - Add it to your devenv.yaml like so From 8941416a484be1037bf5c2a4cff8e1d70a2fe548 Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:44:08 -0500 Subject: [PATCH 6/9] Update docs/reference/yaml-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Domen Kožar --- docs/reference/yaml-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index 327b88422..a046c9831 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -57,7 +57,7 @@ imports: ### What if a package is out of date? - Open [nixpkgs repo](https://github.com/NixOS/nixpkgs) and press `t` to search for your package. - Try to update/change the package using [the nixpkgs contributing guide](https://nixos.org/manual/nixpkgs/stable/#chap-quick-start), optionally contacting the maintainer for help if you get stuck. - - Make a PR, get the URL of the patch + - Make a PR and remember the branch name. - It will take the form of 'github:$GH_USERNAME/nixpkgs/master' - Add it to your devenv.yaml like so From 0a900b0c83e9feeab487db431f321cbbf6b6d27f Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:44:19 -0500 Subject: [PATCH 7/9] Update docs/reference/yaml-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Domen Kožar --- docs/reference/yaml-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index a046c9831..93204aa3f 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -58,7 +58,7 @@ imports: - Open [nixpkgs repo](https://github.com/NixOS/nixpkgs) and press `t` to search for your package. - Try to update/change the package using [the nixpkgs contributing guide](https://nixos.org/manual/nixpkgs/stable/#chap-quick-start), optionally contacting the maintainer for help if you get stuck. - Make a PR and remember the branch name. - - It will take the form of 'github:$GH_USERNAME/nixpkgs/master' +Using the nixpkgs input in form of 'github:$GH_USERNAME/nixpkgs/master', edit `devenv.yaml`: - Add it to your devenv.yaml like so From 659b09e01f378214a18e2621b84c932730755923 Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:44:25 -0500 Subject: [PATCH 8/9] Update docs/reference/yaml-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Domen Kožar --- docs/reference/yaml-options.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index 93204aa3f..db5ce77d3 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -59,7 +59,6 @@ imports: - Try to update/change the package using [the nixpkgs contributing guide](https://nixos.org/manual/nixpkgs/stable/#chap-quick-start), optionally contacting the maintainer for help if you get stuck. - Make a PR and remember the branch name. Using the nixpkgs input in form of 'github:$GH_USERNAME/nixpkgs/master', edit `devenv.yaml`: - - Add it to your devenv.yaml like so ```yaml From afa565fcf160e04e98a562d88ea6c9ba547bf71e Mon Sep 17 00:00:00 2001 From: Matthias Debernardini <32387851+matthiasdebernardini@users.noreply.github.com> Date: Tue, 10 Oct 2023 11:41:52 -0500 Subject: [PATCH 9/9] Update yaml-options.md --- docs/reference/yaml-options.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/reference/yaml-options.md b/docs/reference/yaml-options.md index db5ce77d3..6be96dfdf 100644 --- a/docs/reference/yaml-options.md +++ b/docs/reference/yaml-options.md @@ -58,18 +58,15 @@ imports: - Open [nixpkgs repo](https://github.com/NixOS/nixpkgs) and press `t` to search for your package. - Try to update/change the package using [the nixpkgs contributing guide](https://nixos.org/manual/nixpkgs/stable/#chap-quick-start), optionally contacting the maintainer for help if you get stuck. - Make a PR and remember the branch name. + - Add it to your devenv.yaml like so + Using the nixpkgs input in form of 'github:$GH_USERNAME/nixpkgs/master', edit `devenv.yaml`: ```yaml inputs: nixpkgs: - url: 'github:taylor1791/nixpkgs/master' - fenix: - url: 'github:nix-community/fenix' - inputs: - nixpkgs: - follows: nixpkgs + url: 'github:$GH_USERNAME/nixpkgs/MYBRANCH' ```