Skip to content

RELEASES.md

Latest commit

 

History

History
40 lines (24 loc) · 2.81 KB

RELEASES.md

File metadata and controls

40 lines (24 loc) · 2.81 KB

Releases

This repository has multiple on-chain and off-chain components. Each component has its own release process.

On-chain components

Solidity Contracts

The solidity contracts releases are tagged with the solidity prefix. For example, solidity-v2.0.1. Solidity contract releases follow semantic versioning.

  • Major version bump: A major version bump indicates that there are breaking changes in the API (regardless of whether they require a new initializer or not).
  • Minor version bump: A minor version bump indicates that there are non-breaking changes in the API that require a new initializer (due to storage layout changes).
  • Patch version bump: A patch version bump indicates that there are non-breaking changes in the API that do not require a new initializer (no storage layout changes).

CosmWasm Ethereum Light Client

The CosmWasm Ethereum Light Client releases are tagged with the cw-ics08-wasm-eth prefix. For example, cw-ics08-wasm-eth-v1.3.0. CosmWasm Ethereum Light Client releases follow semantic versioning.

  • Major version bump: A major version bump indicates that there are breaking changes in the API. (This can only happen if there is an API breaking change in ibc-go's 08-wasm module, since the API is defined by the ibc-go interface.)
  • Minor version bump: A minor version bump indicates that there are non-breaking changes in the API that require a state migration (migrate entry point) due to storage layout changes.
  • Patch version bump: A patch version bump indicates that there are non-breaking changes in the API that do not require a state migration (no storage layout changes).

Solana Programs

The Solana programs releases are tagged with the solana prefix. For example, solana-v1.0.0. Solana program releases follow semantic versioning.

  • Major version bump: A major version bump indicates that there are breaking changes in the API.
  • Minor version bump: A minor version bump indicates that there are non-breaking changes in the API that require storage layout changes.
  • Patch version bump: A patch version bump indicates that there are non-breaking changes in the API that do not require storage layout changes.

Off-chain components

Relayer

The relayer releases are tagged with the relayer prefix. For example, relayer-v0.7.0. Relayer releases follow semantic versioning.

The relayer does not have a major release yet, since we want to reserve the right to make breaking changes to the relayer's API until we have a stable API that we are confident will not require breaking changes in the future.

  • Minor version bump: A minor version bump indicates that there are new features or improvements in the relayer.
  • Patch version bump: A patch version bump indicates that there are bug fixes or minor improvements in the relayer.