versioning: add usage comment

This commit is contained in:
Erik Arvstedt 2021-08-15 11:28:43 +02:00
parent ca3c7a281b
commit 13b4650e84
No known key found for this signature in database
GPG Key ID: 33312B944DD97846
1 changed files with 5 additions and 0 deletions

View File

@ -1,5 +1,10 @@
{ config, pkgs, lib, ... }:
# Workflow for releasing a new nix-bitcoin version with incompatible changes:
# Let V be the version of the upcoming, incompatible release.
# 1. Add change descriptions with `version = V` at the end of the `changes` list below.
# 2. Set `nix-bitcoin.configVersion = V` in ../examples/configuration.nix.
with lib;
let
version = config.nix-bitcoin.configVersion;