Merge pull request #105 from kachick/dev-with-nix

Pin bash and asdf-vm versions via Nix for stable development

.envrc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+use flake

.github/renovate.json

@@ -5,7 +5,7 @@
     "github>kachick/renovate-config-dprint"
   ],
   "labels": ["dependencies", "renovate"],
-  "enabledManagers": ["asdf", "regex"],
+  "enabledManagers": ["asdf", "regex", "nix"],
   "prHourlyLimit": 10,
   "prConcurrentLimit": 5,
   "packageRules": [
@@ -15,5 +15,11 @@
       ],
       "rangeStrategy": "bump"
     }
-  ]
+  ],
+  "nix": {
+    "enabled": true
+  },
+  "lockFileMaintenance": {
+    "enabled": true
+  }
 }

.github/workflows/ci-dev.yml

@@ -28,10 +28,13 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-      - uses: asdf-vm/actions/setup@v3
-      - run: 'asdf plugin-add yamlfmt .'
-      - uses: asdf-vm/actions/install@v3
+      - uses: DeterminateSystems/nix-installer-action@v10
+      - run: nix develop --command echo 'This step should be done before any other "nix develop" steps because of measuring Nix build time'
       - run: |
-          makers help
-          makers setup
-          makers check
+          nix develop --command bash -c '
+            asdf plugin-add cargo-make https://github.com/kachick/asdf-cargo-make.git
+            asdf install cargo-make
+            makers help
+            makers setup
+            makers check
+          '

.github/workflows/dependency-review.yml

@@ -19,3 +19,4 @@ jobs:
         with:
           # https://spdx.org/licenses/
           allow-licenses: MIT, BSD-3-Clause, BSD-2-Clause, 0BSD, Unlicense, ISC, Apache-2.0
+          allow-dependencies-licenses: pkg:githubactions/DeterminateSystems/nix-installer-action

.github/workflows/merge-bot-pr.yml

@@ -8,26 +8,36 @@ permissions:
   # actions: read # For private repositories
 
 jobs:
-  dependabot:
+  judge-dependabot:
+    timeout-minutes: 5
     runs-on: ubuntu-latest
+    outputs:
+      merge: ${{ steps.conclusion.outputs.merge }}
     if: ${{ github.actor == 'dependabot[bot]' }}
     steps:
       - name: Dependabot metadata
-        id: metadata
+        id: dependabot
         uses: dependabot/fetch-metadata@v2.0.0
-        with:
-          github-token: '${{ secrets.GITHUB_TOKEN }}'
+      - name: Judge
+        id: conclusion
+        if: >-
+          steps.dependabot.outputs.update-type != 'version-update:semver-major' || contains(steps.dependabot.outputs.dependency-names, 'DeterminateSystems')
+        run: echo -n 'merge=true' | tee -a "$GITHUB_OUTPUT"
+  dependabot:
+    needs: [judge-dependabot]
+    if: ${{ needs.judge-dependabot.outputs.merge == 'true' }}
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
       - uses: actions/checkout@v4
       - name: Wait other jobs
-        if: ${{steps.metadata.outputs.update-type != 'version-update:semver-major'}}
         uses: kachick/wait-other-jobs@v2
         timeout-minutes: 30
         with:
           github-token: '${{ secrets.GITHUB_TOKEN }}'
           retry-method: 'equal_intervals'
           min-interval-seconds: '15'
       - name: Approve and merge
-        if: ${{steps.metadata.outputs.update-type != 'version-update:semver-major'}}
         run: gh pr review --approve "$PR_URL" && gh pr merge --auto --squash "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}

.gitignore

@@ -0,0 +1 @@
+.direnv

CONTRIBUTING.md

@@ -1,5 +1,9 @@
 # Contributing
 
+Maintaining this repository assumes that you are not using old versions of bash such as 3.x, which is included in MacOS\
+I recommend using the [Nix package manager](https://nixos.org/) to prepare base environments.\
+This repository contains the [flake.nix](flake.nix).
+
 After installing asdf, running below command in this repo finishes setups.
 
 ```console

README.md

@@ -7,6 +7,7 @@ Tested also [mise](https://github.com/jdx/mise).
 
 ## Dependencies
 
+- `asdf-vm` or `mise`
 - `bash`, `curl`, `tar`: generic POSIX utilities.
 
 ## Install

flake.nix

@@ -0,0 +1,40 @@
+{
+  inputs = {
+    # Candidate channels
+    #   - https://github.com/kachick/anylang-template/issues/17
+    #   - https://discourse.nixos.org/t/differences-between-nix-channels/13998
+    # How to update the revision
+    #   - `nix flake update --commit-lock-file` # https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake-update.html
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.11";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+      in
+      {
+        formatter = pkgs.nixpkgs-fmt;
+        devShells.default = with pkgs;
+          mkShell {
+            buildInputs = [
+              # - Use newest bash to avoid darwin old bash problems. For example #139
+              # - Avoid https://github.com/NixOS/nix/issues/730#issuecomment-162323824
+              bashInteractive
+
+              # Keep minimum tools in nix layer, this repository should depend them with the asdf or mise itself(.tool-versions)
+              # So written here should be also clarified in [depedndencies](README.md#Dependencies)
+              curl
+              asdf-vm
+              # Also do not specify mise to avoid conflict with asdf
+              # mise
+            ];
+
+            shellHook = ''
+              . "${pkgs.asdf-vm}/share/asdf-vm/asdf.sh"
+            '';
+          };
+      }
+    );
+}

scripts/format.bash

@@ -2,9 +2,12 @@
 
 set -euxo pipefail
 
+# This option don't work in old bash as 3.x that installed in macOS
+shopt -s globstar
+
 shfmt --language-dialect bash --write \
-	./**/*
+	./**/*.bash bin/**/*
 
 dprint fmt
 
-yamlfmt
+yamlfmt -gitignore_excludes

scripts/lint.bash

@@ -2,13 +2,16 @@
 
 set -euxo pipefail
 
+# This option don't work in old bash as 3.x that installed in macOS
+shopt -s globstar
+
 shellcheck --shell=bash --external-sources \
 	bin/* --source-path=lib/ \
 	lib/* \
 	scripts/*
 
 shfmt --language-dialect bash --diff \
-	./**/*
+	./**/*.bash bin/**/*
 
 dprint check