Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a step for incrementing ledger package versions in the release process #6442

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions RELEASE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,12 @@ Another example is if a security audit is done on `rc1`, and the changes in `rc2
- Update the version bounds in cabal files.
- Update the CHaP index state in `cabal.project`.
- Update the CHaP flake input with `nix flake update CHaP`. If you get "error: cannot find flake 'flake:CHaP' in the flake registries" your nix installation probably needs to be updated.
- Update the package versions of affected packages in the cabal files, if needed.
Ledger packages follow a different versioning policy than Plutus packages, where each package is versioned independently.
Each ledger PR is responsible for incrementing the version of any affected ledger package to the next release version (unless this has already been done by a previous PR).
For a PR bumping Plutus version bounds, if there are no other breaking changes, increment the last component of the ledger package versions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "last component" mean? Does it refer to a dependency hierarchy?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I think I understand, it's referring to the structure of the version identifier, like the last component of "1.2.3.4" would be "4". Is that right?

I got confused by the discussion here: https://github.com/IntersectMBO/cardano-ledger/pull/4593/files#r1744246536 . Also, from this and from reading cardano-ledger's release guide I understand that all packages should be updated? Waiting on a response on that PR to be sure.

Otherwise, increment the appropriate component according to the PVP versioning scheme.
See the "CHANGELOG.md" section of the ledger's https://github.com/IntersectMBO/cardano-ledger/blob/master/RELEASING.md[release process] for more details.

9. Make a PR to update the version used in `plutus-tx-template`
- Navigate to the https://github.com/IntersectMBO/plutus-tx-template/actions/workflows/bump-plutus-version.yml[Bump Plutus Version Action] on GitHub
Expand Down