Skip to content

Conversation

@newhoggy
Copy link
Collaborator

Changelog

- description: |
    Prepare release 10.20.0.0 by updating the changelog to document all changes included in this release
    and bumping the version number in the cabal file.
# uncomment types applicable to the change:
  type:
  - release        # related to a new release preparation
  - documentation  # change in code docs, haddocks...
# uncomment at least one main project this PR is associated with
  projects:
  - cardano-api

Context

This PR prepares the 10.20.0.0 release of cardano-api by documenting all the changes that have been merged since the 10.19.1.0 release. This release includes significant improvements to the certificate API and enhancements to TxOut serialization capabilities.

The release contains:

  • Breaking changes: Replacement of the Certificate type in TxCertificates with the new API's Certificate type
  • New features: Additional type class instances for TxOut (HasTypeProxy, FromCBOR, ToCBOR, SerialiseAsCBOR)
  • Refactoring: Deprecation of old certificate API helper functions in favor of new modules

How to trust this PR

This is a straightforward release preparation PR that only updates documentation and version numbers:

  1. CHANGELOG.md: Documents three major changes that were merged in recent PRs (Deprecate "old" certificate api helper functions #983, Add SerialiseAsCBOR instance for TxOut #960, Deprecate certificate in tx certificates #962)
  2. cardano-api.cabal: Bumps version from 10.19.1.0 to 10.20.0.0

The changelog entries accurately describe the merged changes and link to their respective pull requests for full traceability.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

Documents the changes included in the 10.20.0.0 release, providing users
and developers with a comprehensive overview of breaking changes, new
features, and improvements.

- Add changelog entries for certificate API deprecation and refactoring
- Document new type class instances for TxOut (HasTypeProxy, FromCBOR, ToCBOR, SerialiseAsCBOR)
- Note breaking change replacing Certificate type in TxCertificates
- Bump version from 10.19.1.0 to 10.20.0.0 in cabal file

The release focuses on improving the certificate API by introducing new
compatible and experimental modules while deprecating old helper functions,
and enhances TxOut serialization capabilities.
@newhoggy newhoggy force-pushed the release/cardano-api-10.20.0.0 branch from 6a087cd to 80098f1 Compare November 13, 2025 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants