From fe83f2dc862d37bf74edcfc6f390e00a8abc2ec2 Mon Sep 17 00:00:00 2001 From: Andrea Ciceri Date: Wed, 17 Sep 2025 14:34:24 +0200 Subject: [PATCH 1/5] chore(envrc): remove unused `--builders` argument --- .envrc | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.envrc b/.envrc index 5a1af45..4eaafb8 100644 --- a/.envrc +++ b/.envrc @@ -1,5 +1,2 @@ -if ! has nix_direnv_version || ! nix_direnv_version 2.2.0; then - source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/2.2.0/direnvrc" "sha256-5EwyKnkJNQeXrRkYbwwRBcXbibosCJqyIUuz9Xq+LRc=" -fi watch_file ./shell/default.nix flake.lock -use flake . -L --builders '' +use flake . -L From e2d68f60d09c0c4058310d417e8310f95b08312c Mon Sep 17 00:00:00 2001 From: Andrea Ciceri Date: Wed, 17 Sep 2025 14:36:54 +0200 Subject: [PATCH 2/5] chore(shell): add git-cliff --- shell/default.nix | 1 + 1 file changed, 1 insertion(+) diff --git a/shell/default.nix b/shell/default.nix index 1a2f43c..290abf0 100644 --- a/shell/default.nix +++ b/shell/default.nix @@ -25,6 +25,7 @@ statix config.treefmt.build.wrapper reuse + git-cliff ]; commands = [ { From bb861e959f293b21f4060eacd41e7b8d39938a04 Mon Sep 17 00:00:00 2001 From: Andrea Ciceri Date: Wed, 17 Sep 2025 14:37:34 +0200 Subject: [PATCH 3/5] chore(shell): remove useless check Those programs are always available in the shell --- shell/default.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/shell/default.nix b/shell/default.nix index 290abf0..bada654 100644 --- a/shell/default.nix +++ b/shell/default.nix @@ -17,8 +17,8 @@ name = "cardano.nix"; motd = '' ❄️ Welcome to the {14}{bold}cardano.nix{reset} devshell ❄️ - $(type -p menu &>/dev/null && menu) - $(type -p update-pre-commit-hooks &>/dev/null && update-pre-commit-hooks) + $(menu) + $(${config.pre-commit.installationScript}) ''; }; packages = with pkgs; [ From f79c503014ff0c47221f3917991903b508121a66 Mon Sep 17 00:00:00 2001 From: Andrea Ciceri Date: Wed, 17 Sep 2025 14:47:05 +0200 Subject: [PATCH 4/5] chore(changelog): show the changelog on the website --- docs/CHANGELOG.md | 1 + docs/mkdocs.yml | 1 + 2 files changed, 2 insertions(+) create mode 120000 docs/CHANGELOG.md diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 120000 index 0000000..04c99a5 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1 @@ +../CHANGELOG.md \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2d20142..76e1ba9 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -69,6 +69,7 @@ nav: - development/develop.md - development/contributing.md - license.md + - CHANGELOG.md ## Section commented out below, would be autogenerated during docs rendering # - NixOS Module Reference: # - reference/module-options/default.md From 724d4bd4beb1537e55ff13efb8f6e1d2dbc2f615 Mon Sep 17 00:00:00 2001 From: Andrea Ciceri Date: Wed, 17 Sep 2025 15:21:05 +0200 Subject: [PATCH 5/5] chore(changelog): add custom template --- CHANGELOG.md | 2 -- cliff.toml | 27 +++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 cliff.toml diff --git a/CHANGELOG.md b/CHANGELOG.md index c890a6c..8fc9336 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,8 +3,6 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). -## [Unreleased] - ## [1.0.0] - 2025-08-29 ### Initial Release diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..c91a1e7 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,27 @@ + +[changelog] +header = """ +# Changelog + +All notable changes to this project will be documented in this file. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + +""" +body = """ +{% if version -%} + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} +{% else -%} + ## [Unreleased] +{% endif -%} +{% for group, commits in commits | group_by(attribute="group") %} + ## {{ group | title }} + {% for commit in commits %} + - {% if commit.scope %}{{ commit.scope }}: {% endif %}{{ commit.message | split(pat="\n") | first | trim }} + ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/mlabs-haskell/cardano-nix/commit/{{ commit.id }})) - {{ commit.author.name }} ({{ commit.author.timestamp | date(format="%Y-%m-%d") }}) + {% endfor %} +{% endfor %} +""" + +[git] +tag_pattern = "v[0-9]*" +conventional_commits = true