Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
aa4a050390 | ||
|
|
b7558a4218 | ||
|
|
f7dce637d5 | ||
|
|
250882da1f | ||
|
|
e445e49baf | ||
|
|
ef3cf30a34 | ||
|
|
86a0792b6e | ||
|
|
d1aea76dd9 | ||
|
|
cdc9e18035 | ||
|
|
374ba596ab |
@@ -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?ref=v1.0.2#default' --refresh
|
nix flake new myapp -t 'git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.7#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?ref=v1.0.2#
|
|||||||
Add this flake input:
|
Add this flake input:
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
inputs.devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.2";
|
inputs.devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.7";
|
||||||
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`).
|
||||||
|
|||||||
25
flake.nix
25
flake.nix
@@ -82,7 +82,7 @@
|
|||||||
hooks = {
|
hooks = {
|
||||||
treefmt = {
|
treefmt = {
|
||||||
enable = true;
|
enable = true;
|
||||||
entry = "${treefmtEval.config.build.wrapper}/bin/treefmt";
|
entry = "${treefmtEval.config.build.wrapper}/bin/treefmt --ci";
|
||||||
pass_filenames = true;
|
pass_filenames = true;
|
||||||
};
|
};
|
||||||
gitlint.enable = true;
|
gitlint.enable = true;
|
||||||
@@ -96,7 +96,7 @@
|
|||||||
};
|
};
|
||||||
|
|
||||||
toolNameWidth = builtins.foldl' (
|
toolNameWidth = builtins.foldl' (
|
||||||
maxWidth: t: builtins.max maxWidth (builtins.stringLength t.name)
|
maxWidth: t: pkgs.lib.max maxWidth (builtins.stringLength t.name)
|
||||||
) 0 tools;
|
) 0 tools;
|
||||||
toolLabelWidth = toolNameWidth + 1;
|
toolLabelWidth = toolNameWidth + 1;
|
||||||
|
|
||||||
@@ -107,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 %-${toString toolLabelWidth}s$RESET ${colorVar}%s$RESET\n" "${t.name}:" "$(${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;
|
||||||
@@ -300,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"
|
||||||
|
'';
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
@@ -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"
|
||||||
|
|
||||||
|
|||||||
@@ -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.2";
|
devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.7";
|
||||||
devshell-lib.inputs.nixpkgs.follows = "nixpkgs";
|
devshell-lib.inputs.nixpkgs.follows = "nixpkgs";
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -23,81 +23,102 @@
|
|||||||
"aarch64-darwin"
|
"aarch64-darwin"
|
||||||
];
|
];
|
||||||
forAllSystems = nixpkgs.lib.genAttrs supportedSystems;
|
forAllSystems = nixpkgs.lib.genAttrs supportedSystems;
|
||||||
|
|
||||||
|
mkDevShellConfig = pkgs: {
|
||||||
|
# includeStandardPackages = false; # opt out of nixfmt/gitlint/gitleaks/shfmt defaults
|
||||||
|
|
||||||
|
extraPackages = with pkgs; [
|
||||||
|
# add your tools here, e.g.:
|
||||||
|
# go
|
||||||
|
# bun
|
||||||
|
# rustc
|
||||||
|
];
|
||||||
|
|
||||||
|
features = {
|
||||||
|
# oxfmt = true; # enables oxfmt + oxlint from nixpkgs
|
||||||
|
};
|
||||||
|
|
||||||
|
formatters = {
|
||||||
|
# shfmt.enable = true;
|
||||||
|
# gofmt.enable = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
formatterSettings = {
|
||||||
|
# shfmt.options = [ "-i" "2" "-s" "-w" ];
|
||||||
|
# oxfmt.includes = [ "*.ts" "*.tsx" "*.js" "*.json" ];
|
||||||
|
};
|
||||||
|
|
||||||
|
additionalHooks = {
|
||||||
|
tests = {
|
||||||
|
enable = true;
|
||||||
|
entry = "echo 'No tests defined yet.'"; # replace with your test command
|
||||||
|
pass_filenames = false;
|
||||||
|
stages = [ "pre-push" ];
|
||||||
|
};
|
||||||
|
# my-hook = {
|
||||||
|
# enable = true;
|
||||||
|
# entry = "${pkgs.some-tool}/bin/some-tool";
|
||||||
|
# pass_filenames = false;
|
||||||
|
# };
|
||||||
|
};
|
||||||
|
|
||||||
|
tools = [
|
||||||
|
# { name = "Bun"; bin = "${pkgs.bun}/bin/bun"; versionCmd = "--version"; color = "YELLOW"; }
|
||||||
|
# { name = "Go"; bin = "${pkgs.go}/bin/go"; versionCmd = "version"; color = "CYAN"; }
|
||||||
|
# { name = "Rust"; bin = "${pkgs.rustc}/bin/rustc"; versionCmd = "--version"; color = "YELLOW"; }
|
||||||
|
];
|
||||||
|
|
||||||
|
extraShellHook = ''
|
||||||
|
# any repo-specific shell setup here
|
||||||
|
'';
|
||||||
|
};
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
devShells = forAllSystems (
|
devShells = forAllSystems (
|
||||||
system:
|
system:
|
||||||
let
|
let
|
||||||
pkgs = import nixpkgs { inherit system; };
|
pkgs = import nixpkgs { inherit system; };
|
||||||
env = devshell-lib.lib.mkDevShell {
|
config = mkDevShellConfig pkgs;
|
||||||
inherit system;
|
env = devshell-lib.lib.mkDevShell (
|
||||||
|
({ inherit system; } // config)
|
||||||
# includeStandardPackages = false; # opt out of nixfmt/gitlint/gitleaks/shfmt defaults
|
// {
|
||||||
|
extraPackages = config.extraPackages ++ [ self.packages.${system}.release ];
|
||||||
extraPackages = with pkgs; [
|
}
|
||||||
# add your tools here, e.g.:
|
);
|
||||||
# go
|
|
||||||
# bun
|
|
||||||
# rustc
|
|
||||||
];
|
|
||||||
|
|
||||||
features = {
|
|
||||||
# oxfmt = true; # enables oxfmt + oxlint from nixpkgs
|
|
||||||
};
|
|
||||||
|
|
||||||
formatters = {
|
|
||||||
# shfmt.enable = true;
|
|
||||||
# gofmt.enable = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
formatterSettings = {
|
|
||||||
# shfmt.options = [ "-i" "2" "-s" "-w" ];
|
|
||||||
# oxfmt.includes = [ "*.ts" "*.tsx" "*.js" "*.json" ];
|
|
||||||
};
|
|
||||||
|
|
||||||
additionalHooks = {
|
|
||||||
tests = {
|
|
||||||
enable = true;
|
|
||||||
entry = "echo 'No tests defined yet.'"; # replace with your test command
|
|
||||||
pass_filenames = false;
|
|
||||||
stages = [ "pre-push" ];
|
|
||||||
};
|
|
||||||
# my-hook = {
|
|
||||||
# enable = true;
|
|
||||||
# entry = "${pkgs.some-tool}/bin/some-tool";
|
|
||||||
# pass_filenames = false;
|
|
||||||
# };
|
|
||||||
};
|
|
||||||
|
|
||||||
tools = [
|
|
||||||
# { name = "Bun"; bin = "${pkgs.bun}/bin/bun"; versionCmd = "--version"; color = "YELLOW"; }
|
|
||||||
# { name = "Go"; bin = "${pkgs.go}/bin/go"; versionCmd = "version"; color = "CYAN"; }
|
|
||||||
# { name = "Rust"; bin = "${pkgs.rustc}/bin/rustc"; versionCmd = "--version"; color = "YELLOW"; }
|
|
||||||
];
|
|
||||||
|
|
||||||
extraShellHook = ''
|
|
||||||
# any repo-specific shell setup here
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
in
|
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
115
tests/release.sh
Normal 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
|
||||||
Reference in New Issue
Block a user