Skip to content

Commit 001c8dd

Browse files
authored
Merge pull request #90 from input-output-hk/lehins/prepare-release-to-hackage
Prepare release to hackage
2 parents adcc5e8 + 498d68d commit 001c8dd

File tree

2 files changed

+49
-41
lines changed

2 files changed

+49
-41
lines changed

CHANGELOG.md

Lines changed: 47 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,70 @@
1-
# Revision history for cuddle
1+
# Changelog for `cuddle`
22

3-
## 0.1.0.0 -- YYYY-mm-dd
3+
## 1.0.0.0
44

5-
* First version. Released on an unsuspecting world.
5+
* First official release to Hackage
6+
* Added one more parameter to `BindingEnv`
67

7-
## 0.3.0.0 --2024-07-25
8+
## 0.5.0.0
89

9-
* Rationalise the choice operators. Drop (//) and provide detailed comments
10-
explaining the use of (/).
10+
* Implement a validator for CBOR terms.
1111

12-
## 0.3.0.1 -- 2024-07-31
12+
## 0.4.0.0
1313

14-
* Improvements in the pretty printer - various groups should be formatted more
15-
cleanly
14+
* Rewrote the prettyprinter to make the output more human-readable.
15+
* Added `collectFromInit` to make it possible to specify the order of
16+
definitions manually. `collectFrom` and `collectFromInit` now expect
17+
`HuddleItem`s in their arguments
18+
* More Huddle terms now accept comments (e.g. `ArrayEntry`, `ArrayChoice`)
19+
* Parser now preserves most comments.
1620

17-
## 0.3.1.0 -- 2024-08-15
21+
## 0.3.6.0
1822

19-
* `collectFrom` now adds a first definition in the generated Huddle referencing
20-
the top level elements, to be compatible with the CDDL spec.
23+
* Support having keys in group entries. This is needed when using a group to
24+
define a map, or when wishing to include keys in for-use-in-array groups for
25+
documentation purposes. This may introduce problems with existing specifications
26+
where some type hints (using 'a') are needed to properly type entries in groups,
27+
where previously they were unambiguous.
2128

22-
## 0.3.2.0 -- 2024-09-11
29+
Note that it is not yet supported to use a group inside a map, where the
30+
issue of merging keys arises.
2331

24-
* Leading rather than trailing commas in the pretty printer.
32+
## O.3.5.0
2533

26-
## 0.3.3.0 -- 2024-11-13
34+
* Add support for constraints on references and generic references.
35+
* Add support for using references as range bounds. Note that this breaks
36+
backwards compatibility - because the range arguments are now more generic,
37+
additional hints are required to type literal numerics correctly. Typically
38+
this is most easily fixed by adding a call `int` for any numeric literals in
39+
ranges. An example is shown in `example/Conway.hs`
40+
41+
## 0.3.3.0
2742

2843
* Introduce HuddleM, another way to define a Huddle spec. This allows total
2944
control over the order that items are presented in the CDDL, at the cost
3045
of making it somewhat harder to re-use items (they need to be returned from
3146
the monad).
3247

33-
## O.3.5.0 -- 2024-11-25
48+
## 0.3.2.0
3449

35-
* Add support for constraints on references and generic references.
36-
* Add support for using references as range bounds. Note that this breaks
37-
backwards compatibility - because the range arguments are now more generic,
38-
additional hints are required to type literal numerics correctly. Typically
39-
this is most easily fixed by adding a call `int` for any numeric literals in
40-
ranges. An example is shown in `example/Conway.hs`
50+
* Leading rather than trailing commas in the pretty printer.
4151

42-
## 0.3.6.0 -- 2024-12-02
43-
* Support having keys in group entries. This is needed when using a group to
44-
define a map, or when wishing to include keys in for-use-in-array groups for
45-
documentation purposes. This may introduce problems with existing specifications
46-
where some type hints (using 'a') are needed to properly type entries in groups,
47-
where previously they were unambiguous.
52+
## 0.3.1.0
4853

49-
Note that it is not yet supported to use a group inside a map, where the
50-
issue of merging keys arises.
54+
* `collectFrom` now adds a first definition in the generated Huddle referencing
55+
the top level elements, to be compatible with the CDDL spec.
5156

52-
## 0.4.0.0 -- 2025-05-02
53-
* Rewrote the prettyprinter to make the output more human-readable.
54-
* Added `collectFromInit` to make it possible to specify the order of
55-
definitions manually. `collectFrom` and `collectFromInit` now expect
56-
`HuddleItem`s in their arguments
57-
* More Huddle terms now accept comments (e.g. `ArrayEntry`, `ArrayChoice`)
58-
* Parser now preserves most comments.
57+
## 0.3.0.1
5958

60-
## 0.5.0.0 -- 2025-06-03
59+
* Improvements in the pretty printer - various groups should be formatted more
60+
cleanly
61+
62+
## 0.3.0.0
63+
64+
* Rationalise the choice operators. Drop (//) and provide detailed comments
65+
explaining the use of (/).
66+
67+
## 0.1.0.0
68+
69+
* First version. Released on an unsuspecting world.
6170

62-
* Implement a validator for CBOR terms.

cuddle.cabal

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
cabal-version: 3.4
22
name: cuddle
3-
version: 0.5.0.0
3+
version: 1.0.0.0
44
synopsis: CDDL Generator and test utilities
55
description:
66
Cuddle is a library for generating and manipulating [CDDL](https://datatracker.ietf.org/doc/html/rfc8610).
@@ -16,7 +16,7 @@ description:
1616
license: Apache-2.0
1717
license-file: LICENSE
1818
author: IOG Ledger Team
19-
19+
maintainer: [email protected]
2020
copyright: 2025 Input Output Global Inc (IOG)
2121
category: Codec
2222
build-type: Simple

0 commit comments

Comments
 (0)