feat(pkgs/dmd): Automate definition of package versions

.envrc

@@ -1,8 +1,8 @@
 # shellcheck shell=bash
-if ! has nix_direnv_version || ! nix_direnv_version 2.4.0; then
-  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/2.4.0/direnvrc" "sha256-XQzUAvL6pysIJnRJyR7uVpmUSZfc7LSgWQwq/4mBr1U="
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.4; then
+  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.4/direnvrc" "sha256-DzlYZ33mWF/Gs8DDeyjr8mnVmQGx7ASYqA5WlxwvBG4="
 fi
 
 dotenv_if_exists
-nix_direnv_watch_file shell.nix
+watch_file shell.nix
 use flake

.github/workflows/ci.yml

@@ -10,6 +10,10 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   generate-matrix:
     runs-on: ubuntu-latest
@@ -44,9 +48,6 @@ jobs:
       - name: Install Nix
         uses: DeterminateSystems/nix-installer-action@v9
 
-      - name: Run the Magic Nix Cache
-        uses: DeterminateSystems/magic-nix-cache-action@v2
-
       - uses: cachix/cachix-action@v14
         with:
           name: ${{ vars.CACHIX_CACHE }}

.gitignore

@@ -5,7 +5,8 @@ result
 .direnv/
 
 # Dub
-.dub
+.dub/
+bin/
 
 # Dotenv
 .env

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Petar Kirov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,183 @@
+<div align="center" style="margin: 1em 0 3em 0;">
+
+# ![dlang-nix][dlang-nix-badge]
+
+</div>
+
+<div align="center">
+
+[![Built with Nix][built-with-nix-badge]][nix]
+[![Built with D][built-with-d-badge]][d]
+![GitHub Actions][github-actions-badge]
+![GitHub License][github-license-badge]
+
+</div>
+
+This projects provides Nix derivations for building reproducible and declarative development environments for the D programming language.
+
+Currently
+
+This project provides Nix expressions for building DMD, LDC and DUB.
+
+## Usage
+
+### Nix Flakes
+
+While Nix Flakes are still experimental, they are the recommended way to use
+this project, as `flake.lock` files ensure that you will be able to reproduce
+the exact same build in the future. Furthermore, Flakes allow you to benefit
+from the our binary cache -
+[dlang-community.cachix.org][dlang-community-cachix], which is hosted by Cachix.
+
+#### View available packages
+
+```bash
+nix flake show github:PetarKirov/dlang-nix
+```
+
+#### Enter a shell with a particular version of DMD and DUB installed
+
+```bash
+➤ nix shell \
+  github:PetarKirov/dlang-nix#dmd-2_102_2 \
+  github:PetarKirov/dlang-nix#dub-1_30_0
+
+➤ dmd --version
+DMD64 D Compiler v2.102.2
+
+Copyright (C) 1999-2023 by The D Language Foundation, All Rights Reserved written by Walter Bright
+
+➤ dub --version
+DUB version 1.30.0, built on Jan  1 1980
+```
+
+#### Add to your local Nix flakes registry
+
+```bash
+➤ nix registry add d github:PetarKirov/dlang-nix
+
+➤ nix shell d#dmd-2_102_2 d#dub-1_30_0
+
+➤ dmd --version
+DMD64 D Compiler v2.102.2
+
+Copyright (C) 1999-2023 by The D Language Foundation, All Rights Reserved written by Walter Bright
+
+➤ dub --version
+DUB version 1.30.0, built on Jan  1 1980
+```
+
+#### Install packages to your Nix profile
+
+```bash
+➤ nix profile install d#dmd-2_102_2 d#dub-1_30_0 d#ldc_
+```
+
+#### Creating declarative & reproducible development environment
+
+Add the following `flake.nix` to your project:
+
+```nix
+{
+  inputs = {
+    dlang-nix.url = "github:PetarKirov/dlang-nix";
+    nixpkgs.follows = "dlang-nix/nixpkgs";
+    flake-parts = {
+      url = "github:hercules-ci/flake-parts";
+      inputs.nixpkgs-lib.follows = "nixpkgs";
+    };
+  };
+
+  outputs = inputs @ {flake-parts, ...}:
+    flake-parts.lib.mkFlake {inherit inputs;} {
+      systems = ["x86_64-linux" "x86_64-darwin" "aarch64-darwin"];
+      perSystem = { inputs', ... }: {
+        devShells.default = pkgs.mkShell {
+          packages = [
+            inputs'.dlang-nix.packages.ldc
+            inputs'.dlang-nix.packages.dub
+          ];
+        };
+      };
+    };
+}
+```
+
+And then run `nix develop` to enter a shell with the latest LDC and DUB installed:
+
+```bash
+$ dub
+bash: dub: command not found
+
+$ nix develop
+
+$ dub --version
+DUB version 1.30.0, built on Jan  1 1980
+```
+
+You can find the full example in [`templates/devshell/`](./templates/devshell/).
+
+### Pre-flakes usage
+
+The `default.nix` file in the root of this repo exposes all flake outputs as
+Nix attributes. This is useful for users who haven't yet made the jump to the
+Nix Flakes world.
+
+For example, if you have an existing `shell.nix` file, all you need to do is add
+the changes marked as "NEW" from the snippet below:
+
+```nix
+{pkgs ? import <nixpkgs> {}}: let
+  # NEW: Import the dlang-nix Nix library:
+  dlang-nix = import (pkgs.fetchFromGitHub {
+    owner = "PetarKirov";
+    repo = "dlang.nix";
+    rev = "3502a9f6dd2074c2f84d49baa5043f6601ca6407";
+    hash = "sha256-djp8c2iONh+ET+wHbPLruNTuF7xSAYoMmwp1HfsrVTA=";
+  });
+
+  # NEW: Add `dpkgs` shorthand:
+  dpkgs = dlang-nix.packages."${pkgs.system}";
+in
+  pkgs.mkShell {
+    packages = [
+      # NEW: Reference D-related packages from `dpkgs`:
+      dpkgs.dmd
+      dpkgs.dub
+    ];
+  }
+```
+
+You can find the full example in
+[`templates/pre-flake-devshell/`](./templates/pre-flake-devshell/).
+
+## Source and binary variants
+
+DMD and LDC packages come in two variants: `binary` and `source`.
+
+The `binary` variants are based on the the official DMD and LDC releases, but
+repackaged with `autoPatchelfHook` / `fixDarwinDylibNames`.
+
+The `source` variants are built from source using the `binary` package for the
+first step of the bootstrap process.
+
+As far as users of this repo are concerned, both the `binary` and `source`
+variants are distributed as pre-built binaries via the
+[dlang-community.cachix.org][dlang-community-cachix] binary cache.
+
+This is useful for building custom versions of DMD and LDC, or for building DMD
+and LDC with custom patches.
+
+[d]: https://dlang.org
+[nix]: https://nixos.org
+
+[built-with-nix-badge]: https://img.shields.io/static/v1?logo=nixos&logoColor=white&label=&message=Built%20with%20Nix&color=41439a&style=for-the-badge
+[built-with-d-badge]: https://img.shields.io/static/v1?logo=d&logoColor=white&label=&message=Built%20with%20D&color=B03931&style=for-the-badge
+
+[dlang-community-cachix]: https://dlang-community.cachix.org
+
+[github-license-badge]: https://img.shields.io/github/license/PetarKirov/dlang-nix?style=for-the-badge
+
+[github-actions-badge]: https://img.shields.io/badge/github%20actions-black.svg?style=for-the-badge&logo=github&logoColor=white
+
+[dlang-nix-badge]: ./docs/img/dlang.nix-badge.svg

default.nix

@@ -0,0 +1,10 @@
+let
+  lock = builtins.fromJSON (builtins.readFile ./flake.lock);
+  inherit (lock.nodes.flake-compat.locked) owner repo rev narHash;
+  flake-compat = fetchTarball {
+    url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz";
+    sha256 = narHash;
+  };
+  thisFlake = import flake-compat {src = ./.;};
+in
+  thisFlake.defaultNix

flake.nix

@@ -9,6 +9,8 @@
   inputs = {
     nixpkgs.url = github:NixOS/nixpkgs/nixos-unstable;
 
+    flake-compat.url = "github:edolstra/flake-compat";
+
     flake-parts = {
       url = "github:hercules-ci/flake-parts";
       inputs.nixpkgs-lib.follows = "nixpkgs";

lib/build-status.nix

@@ -0,0 +1,13 @@
+{lib, ...}: {
+  getBuildStatus = package: version: system: let
+    data = lib.importJSON ./../pkgs/${package}/build-status.json;
+  in
+    data.${version}.${system}
+    or {
+      # If not build status is found, we assume that the package builds
+      # successfully with no workarounds.
+      build = true;
+      check = true;
+      skippedTests = [];
+    };
+}

lib/mk-gh-actions-matrix.nix

@@ -12,6 +12,8 @@
         # "macos-latest-xlarge" = "aarch64-darwin";
       };
 
+      inherit (import ./build-status.nix {inherit lib;}) getBuildStatus;
+
       mkGHActionsMatrix = {
         include = lib.pipe (builtins.attrNames nixSystemToGHPlatform) [
           (builtins.concatMap
@@ -23,9 +25,9 @@
                   p = self.packages.${system}.${package};
                 in {
                   os = platform;
-                  allowedToFail = builtins.elem system (p.passthru.allowedToFailOn or []);
+                  allowedToFail = !(p.passthru.buildStatus or (throw "${package} does not expose build status")).build;
                   inherit system package;
-                  attrPath = "packages.${system}.${package}";
+                  attrPath = "packages.${system}.${lib.strings.escapeNixIdentifier package}";
                 })
                 (builtins.attrNames self.packages.${system})
             ))