13 Commits

Author SHA1 Message Date
eric
f7dce637d5 chore(release): v1.0.6 2026-03-04 18:46:15 +01:00
eric
250882da1f test: ensure versions are consistent 2026-03-04 18:45:55 +01:00
eric
e445e49baf chore(release): v1.0.5 2026-03-04 09:35:15 +01:00
eric
ef3cf30a34 fix: expose releases as well 2026-03-04 09:35:05 +01:00
eric
86a0792b6e chore(release): v1.0.4 2026-03-04 08:48:24 +01:00
eric
d1aea76dd9 fix: formatting 2026-03-04 08:48:16 +01:00
eric
cdc9e18035 chore(release): v1.0.3 2026-03-04 08:25:29 +01:00
eric
374ba596ab fix: spacing 2026-03-04 08:25:21 +01:00
eric
ffeede1dca chore(release): v1.0.2 2026-03-04 08:21:29 +01:00
eric
a7c17bc738 feat: add more colors 2026-03-04 08:21:20 +01:00
eric
7e93c5267a chore(release): v1.0.1 2026-03-04 07:57:14 +01:00
eric
fd7a2ca07d fix: sed issue with parsing 2026-03-04 07:56:34 +01:00
eric
d7d6a42d48 feat: add tag ref to install commands 2026-03-04 07:55:03 +01:00
6 changed files with 239 additions and 60 deletions

View File

@@ -16,7 +16,7 @@ Simple Nix flake library for:
From your new project folder: From your new project folder:
```bash ```bash
nix flake new myapp -t git+https://git.dgren.dev/eric/nix-flake-lib.git#default nix flake new myapp -t 'git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.6#default' --refresh
``` ```
## Use the library (existing repo) ## Use the library (existing repo)
@@ -24,7 +24,7 @@ nix flake new myapp -t git+https://git.dgren.dev/eric/nix-flake-lib.git#default
Add this flake input: Add this flake input:
```nix ```nix
inputs.devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v0.0.5"; inputs.devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.6";
inputs.devshell-lib.inputs.nixpkgs.follows = "nixpkgs"; inputs.devshell-lib.inputs.nixpkgs.follows = "nixpkgs";
``` ```
@@ -64,9 +64,11 @@ Run releases with:
```bash ```bash
release release
release patch release patch
release beta
release minor beta release minor beta
release stable release stable
release set 1.2.3 release set 1.2.3
``` ```
The release script uses `./VERSION` as the source of truth and creates tags like `v1.2.3`. The release script uses `./VERSION` as the source of truth and creates tags like `v1.2.3`.
When switching from stable to a prerelease channel without an explicit bump (for example, `release beta`), it applies a patch bump automatically (for example, `1.0.0` -> `1.0.1-beta.1`).

View File

@@ -1,3 +1,3 @@
1.0.0 1.0.6
stable stable
0 0

View File

@@ -95,6 +95,11 @@
// additionalHooks; // additionalHooks;
}; };
toolNameWidth = builtins.foldl' (
maxWidth: t: pkgs.lib.max maxWidth (builtins.stringLength t.name)
) 0 tools;
toolLabelWidth = toolNameWidth + 1;
toolBannerScript = pkgs.lib.concatMapStrings ( toolBannerScript = pkgs.lib.concatMapStrings (
t: t:
let let
@@ -102,7 +107,8 @@
in in
'' ''
if command -v ${t.bin} >/dev/null 2>&1; then if command -v ${t.bin} >/dev/null 2>&1; then
printf " $CYAN ${t.name}:$RESET\t${colorVar}%s$RESET\n" "$(${t.bin} ${t.versionCmd})" version="$(${t.bin} ${t.versionCmd} 2>/dev/null | head -n 1 | sed -E 's/^[[:space:]]+//; s/[[:space:]]+$//')"
printf " $CYAN %-${toString toolLabelWidth}s$RESET ${colorVar}%s$RESET\n" "${t.name}:" "$version"
fi fi
'' ''
) tools; ) tools;
@@ -129,6 +135,12 @@
CYAN='\033[1;36m' CYAN='\033[1;36m'
YELLOW='\033[1;33m' YELLOW='\033[1;33m'
BLUE='\033[1;34m' BLUE='\033[1;34m'
RED='\033[1;31m'
MAGENTA='\033[1;35m'
WHITE='\033[1;37m'
GRAY='\033[0;90m'
BOLD='\033[1m'
UNDERLINE='\033[4m'
RESET='\033[0m' RESET='\033[0m'
printf "\n$GREEN 🚀 Dev shell ready$RESET\n\n" printf "\n$GREEN 🚀 Dev shell ready$RESET\n\n"
@@ -250,6 +262,10 @@
run = '' run = ''
sed -E -i "s#^([[:space:]]*devshell-lib\\.url = \")git\\+https://git\\.dgren\\.dev/eric/nix-flake-lib[^\"]*(\";)#\\1git+https://git.dgren.dev/eric/nix-flake-lib?ref=$FULL_TAG\\2#" "$ROOT_DIR/template/flake.nix" sed -E -i "s#^([[:space:]]*devshell-lib\\.url = \")git\\+https://git\\.dgren\\.dev/eric/nix-flake-lib[^\"]*(\";)#\\1git+https://git.dgren.dev/eric/nix-flake-lib?ref=$FULL_TAG\\2#" "$ROOT_DIR/template/flake.nix"
log "Updated template/flake.nix devshell-lib ref to $FULL_TAG" log "Updated template/flake.nix devshell-lib ref to $FULL_TAG"
sed -E -i "s|(nix flake new myapp -t ')git\\+https://git\\.dgren\\.dev/eric/nix-flake-lib[^']*(#default' --refresh)|\\1git+https://git.dgren.dev/eric/nix-flake-lib?ref=$FULL_TAG\\2|" "$ROOT_DIR/README.md"
sed -E -i "s#^([[:space:]]*inputs\\.devshell-lib\\.url = \")git\\+https://git\\.dgren\\.dev/eric/nix-flake-lib[^\"]*(\";)#\\1git+https://git.dgren.dev/eric/nix-flake-lib?ref=$FULL_TAG\\2#" "$ROOT_DIR/README.md"
log "Updated README.md devshell-lib refs to $FULL_TAG"
''; '';
} }
]; ];
@@ -285,10 +301,28 @@
checks = forAllSystems ( checks = forAllSystems (
system: system:
let let
pkgs = import nixpkgs { inherit system; };
env = self.lib.mkDevShell { inherit system; }; env = self.lib.mkDevShell { inherit system; };
in in
{ {
inherit (env) pre-commit-check; inherit (env) pre-commit-check;
release-tests =
pkgs.runCommand "release-tests"
{
nativeBuildInputs = with pkgs; [
bash
git
gnused
coreutils
gnugrep
];
}
''
export REPO_LIB_ROOT=${./.}
export HOME="$TMPDIR"
${pkgs.bash}/bin/bash ${./tests/release.sh}
touch "$out"
'';
} }
); );

View File

@@ -23,11 +23,12 @@ usage() {
" (none) bump patch, keep current channel" \ " (none) bump patch, keep current channel" \
" major/minor/patch bump the given part, keep current channel" \ " major/minor/patch bump the given part, keep current channel" \
" stable / full remove prerelease suffix" \ " stable / full remove prerelease suffix" \
" __CHANNEL_LIST__ switch channel (bumps prerelease number if same base+channel)" \ " __CHANNEL_LIST__ switch channel (from stable, auto-bumps patch unless bump is specified)" \
"" \ "" \
"Examples:" \ "Examples:" \
" ${cmd} # patch bump on current channel" \ " ${cmd} # patch bump on current channel" \
" ${cmd} minor # minor bump on current channel" \ " ${cmd} minor # minor bump on current channel" \
" ${cmd} beta # from stable: patch bump + beta.1" \
" ${cmd} patch beta # patch bump, switch to beta channel" \ " ${cmd} patch beta # patch bump, switch to beta channel" \
" ${cmd} rc # switch to rc channel" \ " ${cmd} rc # switch to rc channel" \
" ${cmd} stable # promote to stable release" \ " ${cmd} stable # promote to stable release" \
@@ -310,7 +311,7 @@ main() {
esac esac
else else
local part="" target_channel="" local part="" target_channel="" was_channel_only=0
case "$action" in case "$action" in
"") part="patch" ;; "") part="patch" ;;
@@ -331,6 +332,7 @@ main() {
if [[ $is_channel == 1 ]]; then if [[ $is_channel == 1 ]]; then
[[ -n ${1-} ]] && echo "Error: channel-only bump takes no second argument" >&2 && usage && exit 1 [[ -n ${1-} ]] && echo "Error: channel-only bump takes no second argument" >&2 && usage && exit 1
target_channel="$action" target_channel="$action"
was_channel_only=1
else else
echo "Error: unknown argument '$action'" >&2 echo "Error: unknown argument '$action'" >&2
usage usage
@@ -343,6 +345,10 @@ main() {
[[ $target_channel == "full" ]] && target_channel="stable" [[ $target_channel == "full" ]] && target_channel="stable"
validate_channel "$target_channel" validate_channel "$target_channel"
if [[ -z $part && $was_channel_only -eq 1 && $CHANNEL == "stable" && $target_channel != "stable" ]]; then
part="patch"
fi
local old_base="$BASE_VERSION" old_channel="$CHANNEL" old_pre="$PRERELEASE_NUM" local old_base="$BASE_VERSION" old_channel="$CHANNEL" old_pre="$PRERELEASE_NUM"
[[ -n $part ]] && bump_base_version "$part" [[ -n $part ]] && bump_base_version "$part"

View File

@@ -4,7 +4,7 @@
inputs = { inputs = {
nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable"; nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.0"; devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.6";
devshell-lib.inputs.nixpkgs.follows = "nixpkgs"; devshell-lib.inputs.nixpkgs.follows = "nixpkgs";
}; };
@@ -23,15 +23,8 @@
"aarch64-darwin" "aarch64-darwin"
]; ];
forAllSystems = nixpkgs.lib.genAttrs supportedSystems; forAllSystems = nixpkgs.lib.genAttrs supportedSystems;
in
{
devShells = forAllSystems (
system:
let
pkgs = import nixpkgs { inherit system; };
env = devshell-lib.lib.mkDevShell {
inherit system;
mkDevShellConfig = pkgs: {
# includeStandardPackages = false; # opt out of nixfmt/gitlint/gitleaks/shfmt defaults # includeStandardPackages = false; # opt out of nixfmt/gitlint/gitleaks/shfmt defaults
extraPackages = with pkgs; [ extraPackages = with pkgs; [
@@ -80,24 +73,52 @@
''; '';
}; };
in in
{
devShells = forAllSystems (
system:
let
pkgs = import nixpkgs { inherit system; };
config = mkDevShellConfig pkgs;
env = devshell-lib.lib.mkDevShell (
({ inherit system; } // config)
// {
extraPackages = config.extraPackages ++ [ self.packages.${system}.release ];
}
);
in
{ {
default = env.shell; default = env.shell;
} }
); );
packages = forAllSystems (system: {
release = devshell-lib.lib.mkRelease {
inherit system;
};
});
checks = forAllSystems ( checks = forAllSystems (
system: system:
let let
env = devshell-lib.lib.mkDevShell { inherit system; }; pkgs = import nixpkgs { inherit system; };
config = mkDevShellConfig pkgs;
env = devshell-lib.lib.mkDevShell ({ inherit system; } // config);
in in
{ {
inherit (env) pre-commit-check; inherit (env) pre-commit-check;
} }
); );
formatter = forAllSystems (system: (devshell-lib.lib.mkDevShell { inherit system; }).formatter); formatter = forAllSystems (
system:
let
pkgs = import nixpkgs { inherit system; };
config = mkDevShellConfig pkgs;
in
(devshell-lib.lib.mkDevShell ({ inherit system; } // config)).formatter
);
# Optional: release command (`release`) # Release command (`release`)
# #
# The release script always updates VERSION first, then: # The release script always updates VERSION first, then:
# 1) runs release steps in order (file writes and scripts) # 1) runs release steps in order (file writes and scripts)
@@ -107,6 +128,7 @@
# Runtime env vars available in release.run/postVersion: # Runtime env vars available in release.run/postVersion:
# BASE_VERSION, CHANNEL, PRERELEASE_NUM, FULL_VERSION, FULL_TAG # BASE_VERSION, CHANNEL, PRERELEASE_NUM, FULL_VERSION, FULL_TAG
# #
# To customize release behavior in your repo, edit:
# packages = forAllSystems ( # packages = forAllSystems (
# system: # system:
# { # {

115
tests/release.sh Normal file
View File

@@ -0,0 +1,115 @@
#!/usr/bin/env bash
set -euo pipefail
ROOT_DIR="${REPO_LIB_ROOT:-$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)}"
RELEASE_TEMPLATE="$ROOT_DIR/packages/release/release.sh"
fail() {
echo "[test] FAIL: $*" >&2
exit 1
}
assert_eq() {
local expected="$1"
local actual="$2"
local message="$3"
if [[ "$expected" != "$actual" ]]; then
fail "$message (expected '$expected', got '$actual')"
fi
}
make_release_script() {
local target="$1"
sed \
-e 's/__CHANNEL_LIST__/alpha beta rc internal/g' \
-e 's/__RELEASE_STEPS__/:/' \
-e 's/__POST_VERSION__/:/' \
"$RELEASE_TEMPLATE" >"$target"
chmod +x "$target"
}
setup_repo() {
local repo_dir="$1"
local remote_dir="$2"
mkdir -p "$repo_dir"
git -C "$repo_dir" init >/dev/null
git -C "$repo_dir" config user.name "Release Test"
git -C "$repo_dir" config user.email "release-test@example.com"
cat >"$repo_dir/flake.nix" <<'EOF'
{
description = "release test";
outputs = { self }: { };
}
EOF
printf '1.0.0\nstable\n0\n' >"$repo_dir/VERSION"
git -C "$repo_dir" add -A
git -C "$repo_dir" commit -m "init" >/dev/null
git init --bare "$remote_dir" >/dev/null
git -C "$repo_dir" remote add origin "$remote_dir"
git -C "$repo_dir" push -u origin HEAD >/dev/null
}
version_from_file() {
local repo_dir="$1"
local base channel n
base="$(sed -n '1p' "$repo_dir/VERSION" | tr -d '\r')"
channel="$(sed -n '2p' "$repo_dir/VERSION" | tr -d '\r')"
n="$(sed -n '3p' "$repo_dir/VERSION" | tr -d '\r')"
if [[ -z "$channel" || "$channel" == "stable" ]]; then
echo "$base"
else
echo "$base-$channel.$n"
fi
}
run_case() {
local case_name="$1"
local command_args="$2"
local expected_version="$3"
local workdir
workdir="$(mktemp -d)"
local repo_dir="$workdir/repo"
local remote_dir="$workdir/remote.git"
setup_repo "$repo_dir" "$remote_dir"
make_release_script "$repo_dir/release"
mkdir -p "$repo_dir/bin"
cat >"$repo_dir/bin/nix" <<'EOF'
#!/usr/bin/env bash
if [[ "${1-}" == "fmt" ]]; then
exit 0
fi
echo "unexpected nix invocation: $*" >&2
exit 1
EOF
chmod +x "$repo_dir/bin/nix"
(
cd "$repo_dir"
PATH="$repo_dir/bin:$PATH" ./release $command_args >/dev/null
)
local got_version
got_version="$(version_from_file "$repo_dir")"
assert_eq "$expected_version" "$got_version" "$case_name: VERSION mismatch"
if ! git -C "$repo_dir" tag --list | grep -qx "v$expected_version"; then
fail "$case_name: expected tag v$expected_version was not created"
fi
rm -rf "$workdir"
echo "[test] PASS: $case_name" >&2
}
run_case "channel-only from stable bumps patch" "beta" "1.0.1-beta.1"
run_case "explicit minor bump keeps requested bump" "minor beta" "1.1.0-beta.1"
echo "[test] All release tests passed" >&2