Merge pull request #5029 from IntersectMBO/coot/release-0.19

ouroboros-network-0.19 release
IntersectMBO · Jan 2, 2025 · ed639f2 · ed639f2
2 parents b9f970f + 56c66ee
commit ed639f2
Show file tree

Hide file tree

Showing 18 changed files with 127 additions and 46 deletions.
diff --git a/cardano-client/CHANGELOG.md b/cardano-client/CHANGELOG.md
@@ -4,10 +4,14 @@
 
 ### Breaking changes
 
-* Addapted to `network-mux` changes in https://github.com/IntersectMBO/ouroboros-network/pull/4997
-
 ### Non-breaking changes
 
+## 0.5.0.0 -- 2025-01-02
+
+### Breaking changes
+
+* Addapted to `network-mux` changes in https://github.com/IntersectMBO/ouroboros-network/pull/4997
+
 ## 0.4.0.0 -- 2024-10-17
 
 ### Breaking changes

diff --git a/cardano-client/cardano-client.cabal b/cardano-client/cardano-client.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: cardano-client
-version: 0.4
+version: 0.5
 synopsis: An API for ouroboros-network
 description: An API for ouroboros-network.
 license: Apache-2.0
@@ -26,10 +26,10 @@ library
     cborg,
     containers,
     contra-tracer,
-    network-mux ^>=0.5,
-    ouroboros-network ^>=0.18,
-    ouroboros-network-api ^>=0.11,
-    ouroboros-network-framework ^>=0.14,
+    network-mux ^>=0.6,
+    ouroboros-network ^>=0.19,
+    ouroboros-network-api ^>=0.12,
+    ouroboros-network-framework ^>=0.15,
     si-timers,
 
   ghc-options:

diff --git a/cardano-ping/CHANGELOG.md b/cardano-ping/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Revision history for cardano-ping
 
+## 0.7.0.0 -- 2024-10-17
+
+### Breaking changes
+
+* Updated dependencies.
+
 ## 0.6.0.0 -- 2024-10-17
 
 ### Breaking changes

diff --git a/cardano-ping/cardano-ping.cabal b/cardano-ping/cardano-ping.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: cardano-ping
-version: 0.6.0.0
+version: 0.7.0.0
 synopsis: Utility for pinging cardano nodes
 description: Utility for pinging cardano nodes.
 license: Apache-2.0
@@ -36,7 +36,7 @@ library
     contra-tracer >=0.1 && <0.3,
     iproute ^>=1.7.15,
     network >=3.1.2.2 && <3.2,
-    network-mux ^>=0.5,
+    network-mux ^>=0.6,
     si-timers ^>=1.5,
     strict-stm,
     tdigest ^>=0.3,

diff --git a/network-mux/CHANGELOG.md b/network-mux/CHANGELOG.md
@@ -4,6 +4,12 @@
 
 ### Breaking changes
 
+### Non-breaking changes
+
+## 0.6.0.0 -- 2025-01-02
+
+### Breaking changes
+
 * Removed `Mux` prefix from many data types & functions.  Mux library should be
   imported qualified.
 

diff --git a/network-mux/network-mux.cabal b/network-mux/network-mux.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: network-mux
-version: 0.5
+version: 0.6
 synopsis: Multiplexing library
 description: Multiplexing library.
 license: Apache-2.0

diff --git a/ouroboros-network-api/CHANGELOG.md b/ouroboros-network-api/CHANGELOG.md
@@ -4,6 +4,12 @@
 
 ### Breaking changes
 
+### Non-breaking changes
+
+## 0.12.0.0 -- 2025-01-02
+
+### Breaking changes
+
 * Removed deprecated APIs
   * `getLegacyTipBlockNo`
   * `legacyTip`

diff --git a/ouroboros-network-api/ouroboros-network-api.cabal b/ouroboros-network-api/ouroboros-network-api.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-network-api
-version: 0.11.0.0
+version: 0.12.0.0
 synopsis: A networking api shared with ouroboros-consensus
 description: A networking api shared with ouroboros-consensus.
 license: Apache-2.0
@@ -70,7 +70,7 @@ library
     iproute ^>=1.7.15,
     measures,
     network >=3.1.2 && <3.2,
-    network-mux ^>=0.5,
+    network-mux ^>=0.6,
     nothunks,
     quiet,
     serialise >=0.2 && <0.3,

diff --git a/ouroboros-network-framework/CHANGELOG.md b/ouroboros-network-framework/CHANGELOG.md
@@ -1,9 +1,25 @@
 # Revision history for ouroboros-network-framework
 
-# next release
+## next release
 
 ### Breaking changes
 
+### Non-breaking changes
+
+## 0.15.0.0 -- 2025-01-02
+
+### Breaking changes
+
+* `Ouroboros.Network.Subscription` removed.
+* `Ouroboros.Network.ErrorPolicy` removed.
+* APIs removed from `Ouroboros.Network.Socket`:
+  * `NetworkMutableState` & friends,
+  * `withServerNode` and `withServerNode'`,
+  * `NetworkServerTracers`,
+  * `fromSnocket`,
+  * `beginConnection`
+* `Ouroboros.Network.Server.Socket` replaced with a simpler server
+  implementation in `Test.Ouroboros.Network.Server` (in `ouroboros-network:testlib` component).
 * Use `IOError` in `BearerInfo`.
 * Addapted to `network-mux` changes in https://github.com/IntersectMBO/ouroboros-network/pull/4999
 * Addapted to `network-mux` changes in https://github.com/IntersectMBO/ouroboros-network/pull/4997

diff --git a/ouroboros-network-framework/ouroboros-network-framework.cabal b/ouroboros-network-framework/ouroboros-network-framework.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-network-framework
-version: 0.14.0.0
+version: 0.15.0.0
 synopsis: Ouroboros network framework
 description: Ouroboros network framework.
 license: Apache-2.0
@@ -86,13 +86,13 @@ library
     hashable,
     io-classes ^>=1.5.0,
     iproute >=1.7 && <1.8,
-    monoidal-synchronisation ^>=0.1.0.5,
+    monoidal-synchronisation ^>=0.1.0.6,
     mtl,
     network ^>=3.1.4,
-    network-mux ^>=0.5,
+    network-mux ^>=0.6,
     nothunks,
     nothunks ^>=0.1.4 || ^>=0.2,
-    ouroboros-network-api ^>=0.11,
+    ouroboros-network-api ^>=0.12,
     ouroboros-network-testing,
     psqueues,
     quiet,

diff --git a/ouroboros-network-protocols/CHANGELOG.md b/ouroboros-network-protocols/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Revision history for ouroboros-network-protocols
 
+## 0.13.0.0 -- 2025-01-02
+
+### Breaking changes
+
+* Removed deprecated API
+
 ## 0.12.0.0 -- 2024-10-17
 
 ### Breaking changes

diff --git a/ouroboros-network-protocols/ouroboros-network-protocols.cabal b/ouroboros-network-protocols/ouroboros-network-protocols.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-network-protocols
-version: 0.12.0.0
+version: 0.13.0.0
 synopsis: Ouroboros Network Protocols
 description: Ouroboros Network Protocols.
 license: Apache-2.0
@@ -103,7 +103,7 @@ library
     deepseq,
     io-classes ^>=1.5.0,
     nothunks,
-    ouroboros-network-api ^>=0.11,
+    ouroboros-network-api ^>=0.12,
     quiet,
     serialise,
     si-timers,
@@ -231,7 +231,7 @@ test-suite test
     ouroboros-network-api,
     ouroboros-network-mock,
     ouroboros-network-protocols:testlib,
-    ouroboros-network-testing ^>=0.7.0,
+    ouroboros-network-testing ^>=0.8,
     tasty,
     tasty-quickcheck,
 

diff --git a/ouroboros-network-testing/CHANGELOG.md b/ouroboros-network-testing/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Revision history for ouroboros-network-testing
 
-## next version
+## next release
+
+### Breaking changes
+
+### Non-breaking changes
+
+## 0.8.0.0 -- 2025-01-02
 
 ### Breaking changes
 

diff --git a/ouroboros-network-testing/ouroboros-network-testing.cabal b/ouroboros-network-testing/ouroboros-network-testing.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-network-testing
-version: 0.7.0.0
+version: 0.8.0.0
 synopsis: Common modules used for testing in ouroboros-network and ouroboros-consensus
 description: Common modules used for testing in ouroboros-network and ouroboros-consensus.
 license: Apache-2.0

diff --git a/ouroboros-network/CHANGELOG.md b/ouroboros-network/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Revision history for ouroboros-network
 
-## next version
+## next release
+
+### Breaking changes
+
+### Non-breaking changes
+
+## 0.19.0.0 -- 2025-01-02
 
 ### Breaking changes
 

diff --git a/ouroboros-network/ouroboros-network.cabal b/ouroboros-network/ouroboros-network.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-network
-version: 0.18.0.0
+version: 0.19.0.0
 synopsis: A networking layer for the Ouroboros blockchain protocol
 description: A networking layer for the Ouroboros blockchain protocol.
 license: Apache-2.0
@@ -164,9 +164,9 @@ library
     network ^>=3.1.4,
     network-mux,
     nothunks,
-    ouroboros-network-api ^>=0.11,
-    ouroboros-network-framework ^>=0.14,
-    ouroboros-network-protocols ^>=0.12,
+    ouroboros-network-api ^>=0.12,
+    ouroboros-network-framework ^>=0.15,
+    ouroboros-network-protocols ^>=0.13,
     psqueues >=0.2.3 && <0.3,
     random,
     si-timers,
@@ -224,7 +224,7 @@ library sim-tests-lib
     ouroboros-network-mock,
     ouroboros-network-protocols,
     ouroboros-network-protocols:testlib,
-    ouroboros-network-testing ^>=0.7.0,
+    ouroboros-network-testing ^>=0.8,
     pipes,
     pretty-simple,
     psqueues,
@@ -328,7 +328,7 @@ test-suite io-tests
     ouroboros-network-mock,
     ouroboros-network-protocols,
     ouroboros-network-protocols:testlib,
-    ouroboros-network-testing ^>=0.7.0.0,
+    ouroboros-network-testing ^>=0.8,
     serialise,
     si-timers,
     strict-stm,

diff --git a/scripts/build-with-chap.sh b/scripts/build-with-chap.sh
@@ -13,6 +13,30 @@ which yq # https://github.com/mikefarah/yq#install
 
 CHAP_DIR=${CARDANO_HASKELL_PACKAGES_DIR:-"/tmp/chap"}
 
+function usage {
+  echo "Build against cardano-haskell-packages branch"
+  echo "-h help message "
+  echo "-t build a release from a custom branch rather than main or release/* branches"
+  echo "Set CARDANO_HASKELL_PACKAGES_DIR env variable to point to CHaP directory, if not set '/tmp/chap' will be used."
+}
+
+optstring="ht"
+TEST=0
+while getopts ${optstring} arg; do
+  case ${arg} in
+    h)
+      usage
+      exit 0
+      ;;
+    t)
+      TEST=1
+      ;;
+    ?)
+      echo "Invalid option '-${arg}'."
+      exit 2
+  esac
+done
+
 if [[ -n "$(git status --untracked-files=no --porcelain)" ]];then
   echo "error: not a clean directory"
   exit 1
@@ -36,20 +60,22 @@ done
 cabal build all
 git reset --hard HEAD
 
-# check that all revs are on `master` or `release\/*` branches.
-for cf in $cabal_files; do
-  name=$(cat $cf | grep '^name:' | awk '{ print $2 }')
-  version=$(ls -1 $CHAP_DIR/_sources/$name | sort -V | tail -1)
-  rev=$(yq .github.rev $CHAP_DIR/_sources/$name/$version/meta.toml)
-  ! { git branch -l --contains $rev --format="%(refname:short)" | grep -e '^\(master\|release//\)'; }
-  if [[ $? == 0 ]]; then
-    echo "$name: revision $rev is not on the master or a 'release/*' branch."
-    exit 1
-  fi
-done
+# check that all revs are on `main` or `release\/*` branches.
+if [[ $TEST == 0 ]]; then
+  for cf in $cabal_files; do
+    name=$(cat $cf | grep '^name:' | awk '{ print $2 }')
+    version=$(ls -1 $CHAP_DIR/_sources/$name | sort -V | tail -1)
+    rev=$(yq .github.rev $CHAP_DIR/_sources/$name/$version/meta.toml)
+    ! { git branch -l --contains $rev --format="%(refname:short)" | grep -e '^\(master\|release//\)'; }
+    if [[ $? == 0 ]]; then
+      echo "$name: revision $rev is not on the master or a 'release/*' branch."
+      exit 1
+    fi
+  done
+fi
 
 pushd $CHAP_DIR
 git symbolic-ref --short HEAD
-if [[ $(git symbolic-ref --short HEAD) =~ ^network\/release- ]] then
+if [[ $TEST == 0 && $(git symbolic-ref --short HEAD) =~ ^network\/release- ]] then
   gh pr comment --body "* [x] checked with \`build-with-chap.sh\` in \`ouroboros-network\`"
 fi
diff --git a/scripts/release-to-chap.sh b/scripts/release-to-chap.sh
@@ -11,8 +11,8 @@ function usage {
   echo "Release packages to CHaP and create a PR."
   echo "-h help message "
   echo "-r report unreleased changes"
-  echo "-t build a release from a custom branch rather than master or release/* branches"
-  echo "Set CHAP_DIR env variable to point to CHaP direcotory, if not set '/tmp/chap' will be used."
+  echo "-t build a release from a custom branch rather than main or release/* branches"
+  echo "Set CARDANO_HASKELL_PACKAGES_DIR env variable to point to CHaP directory, if not set '/tmp/chap' will be used."
 }
 
 REPORT=0
@@ -36,7 +36,6 @@ while getopts ${optstring} arg; do
       exit 2
   esac
 done
-echo "TEST=$TEST"
 
 REPO_URL="https://github.com/intersectmbo/ouroboros-network"
 
@@ -63,8 +62,8 @@ if [[ $REPORT == 1 ]] then
 else
 
   branch=$(git rev-parse --abbrev-ref HEAD)
-  if [[ !($TEST) && !($branch =~ ^(master|release/.*)$) ]]; then
-    echo "error: one must release from master or a release/* branch, pass a -t switch to skip this test"
+  if [[ !($TEST) && !($branch =~ ^(main|release/.*)$) ]]; then
+    echo "error: one must release from main or a release/* branch, pass a -t switch to skip this test"
     exit 1
   fi