setup scriv for changelog management

coot · coot · commit 624799d256d5 · 2025-09-10T15:00:18.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -296,9 +296,9 @@ need to delete branch created in `cardano-haskell-packages`.
 
 * First run `./script/release-to-chap.sh -r` to see which changes can be
   published.
-* Update versions in `*.cabal` files according to changes in `CHANGELOG.md`
-  files.
-* Update `CHANGELOG.md` files.
+* Update versions in `*.cabal` files according to changelog fragments in `changelog.d` directory
+  (using `scriv print` might be helpful to see the changes).
+* Collect `CHANGELOG.md` using `scriv collect` (available in `nix develop`)
 * Run `./script/release-to-chap.sh` which will create a branch in
   `cardano-haskell-packages` repo (pointed by `CARDANO_HASKELL_PACKAGES_DIR`
   environment variable or `/tmp/chap` if it's not defined).
diff --git a/acts-generic/CHANGELOG.md b/acts-generic/CHANGELOG.md
@@ -1,4 +1,6 @@
-# Revision history for acts-generic
+# acts-generic changelog
+
+<!-- scriv-end-here -->
 
 ## 0.1.0.0 -- YYYY-mm-dd
 
diff --git a/acts-generic/changelog.d/scriv.ini b/acts-generic/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: acts-generic.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/cardano-client/CHANGELOG.md b/cardano-client/CHANGELOG.md
@@ -1,10 +1,6 @@
-# Revision history for cardano-client
+# cardano-client changelog
 
-## next release
-
-### Breaking changes
-
-### Non-breaking changes
+<!-- scriv-end-here -->
 
 ## 0.6.0.0 -- 2025-06-28
 
diff --git a/cardano-client/changelog.d/scriv.ini b/cardano-client/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: cardano-client.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/cardano-ping/CHANGELOG.md b/cardano-ping/CHANGELOG.md
@@ -1,10 +1,6 @@
-# Revision history for cardano-ping
+# cardano-ping changelog
 
-## next version
-
-### Breaking changes
-
-### Non-breaking changes
+<!-- scriv-end-here -->
 
 ## 0.9.0.0 -- 2026-06-28
 
diff --git a/cardano-ping/changelog.d/scriv.ini b/cardano-ping/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: cardano-ping.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/dmq-node/CHANGELOG.md b/dmq-node/CHANGELOG.md
@@ -1,4 +1,6 @@
-# Revision history for decentralized-message-queue
+# dmq-node changelog
+
+<!-- scriv-end-here -->
 
 ## 0.1.0.0 -- YYYY-mm-dd
 
diff --git a/dmq-node/changelog.d/scriv.ini b/dmq-node/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: dmq-node.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/monoidal-synchronisation/CHANGELOG.md b/monoidal-synchronisation/CHANGELOG.md
@@ -1,11 +1,9 @@
-# Revision history for monoidal-synchronisation
+# monoidal-synchronisation changelog
 
-## next version
+<!-- scriv-end-here -->
 
 ## 0.1.0.6 - 2024-08-07
 
-### Breaking changes
-
 ### Non-breaking changes
 
 * Make it build with ghc-9.10
diff --git a/monoidal-synchronisation/changelog.d/scriv.ini b/monoidal-synchronisation/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: monoidal-synchronisation.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/network-mux/CHANGELOG.md b/network-mux/CHANGELOG.md
@@ -1,10 +1,6 @@
-# Revision history for mux
+# network-mux changelog
 
-## next release
-
-### Breaking changes
-
-### Non-breaking changes
+<!-- scriv-end-here -->
 
 ## 0.9.1.0 -- 2025-09-10
 
diff --git a/network-mux/changelog.d/scriv.ini b/network-mux/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: network-mux.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/nix/shell.nix b/nix/shell.nix
@@ -41,6 +41,7 @@ hsPkgs.shellFor {
     pkgs.jq
     pkgs.yq-go
     pkgs.gh
+    pkgs.scriv
   ];
 
   # This is the place for tools that are required to be built with the same GHC
diff --git a/ntp-client/CHANGELOG.md b/ntp-client/CHANGELOG.md
@@ -1,6 +1,6 @@
-# Revision history for ntp-client
+# ntp-client changelog
 
-## next release
+<!-- scriv-end-here -->
 
 ## 0.0.1.6 -- 2024-08-07
 
diff --git a/ntp-client/changelog.d/scriv.ini b/ntp-client/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ntp-client.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/ouroboros-network-api/CHANGELOG.md b/ouroboros-network-api/CHANGELOG.md
@@ -1,8 +1,6 @@
-# Revision history for ouroboros-network-api
+# ouroboros-network-api changelog
 
-## next release
-
-### Breaking changes
+<!-- scriv-end-here -->
 
 ## 0.17.0.0 -- 2025-09-10
 
diff --git a/ouroboros-network-api/changelog.d/scriv.ini b/ouroboros-network-api/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ouroboros-network-api.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/ouroboros-network-framework/CHANGELOG.md b/ouroboros-network-framework/CHANGELOG.md
@@ -1,10 +1,6 @@
 # Revision history for ouroboros-network-framework
 
-## next release
-
-### Breaking changes
-
-### Non-breaking changes
+<!-- scriv-end-here -->
 
 ## 0.20.0.0 -- 10.09.2025
 
diff --git a/ouroboros-network-framework/changelog.d/scriv.ini b/ouroboros-network-framework/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ouroboros-network-framework.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/ouroboros-network-mock/CHANGELOG.md b/ouroboros-network-mock/CHANGELOG.md
@@ -1,6 +1,6 @@
-# Revision history for ouroboros-network-mock
+# ouroboros-network-mock changelog
 
-## next release
+<!-- scriv-end-here -->
 
 ## 0.1.1.2 -- 2024-08-07
 
diff --git a/ouroboros-network-mock/changelog.d/scriv.ini b/ouroboros-network-mock/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ouroboros-network-mock.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/ouroboros-network-protocols/CHANGELOG.md b/ouroboros-network-protocols/CHANGELOG.md
@@ -1,8 +1,6 @@
-# Revision history for ouroboros-network-protocols
+# ouroboros-network-protocols changelog
 
-## next release
-
-### Breaking changes
+<!-- scriv-end-here -->
 
 ## 0.16.0.0 -- 2025-09-10
 
diff --git a/ouroboros-network-protocols/changelog.d/scriv.ini b/ouroboros-network-protocols/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ouroboros-network-protocols.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/ouroboros-network-testing/CHANGELOG.md b/ouroboros-network-testing/CHANGELOG.md
@@ -1,10 +1,6 @@
-# Revision history for ouroboros-network-testing
+# ouroboros-network-testing changelog
 
-## next release
-
-### Breaking changes
-
-### Non-breaking changes
+<!-- scriv-end-here -->
 
 ## 0.8.3.0 -- 10.09.2025
 
diff --git a/ouroboros-network-testing/changelog.d/scriv.ini b/ouroboros-network-testing/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ouroboros-network-testing.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
diff --git a/ouroboros-network/CHANGELOG.md b/ouroboros-network/CHANGELOG.md
@@ -1,10 +1,6 @@
-# Revision history for ouroboros-network
+# ouroboros-network changelog
 
-## next release
-
-### Breaking changes
-
-### Non-breaking changes
+<!-- scriv-end-here -->
 
 ## 0.23.0.0 -- 2025-09-10
 
diff --git a/ouroboros-network/changelog.d/scriv.ini b/ouroboros-network/changelog.d/scriv.ini
@@ -0,0 +1,14 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ouroboros-network.cabal: version
+categories = Breaking, Non-Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = main
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
+entry_title_template = {%% if version %%}{{ version }} -- {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}
