Skip to content

Commit

Permalink
docs: reject ADR 012 (#1407)
Browse files Browse the repository at this point in the history
reject ADR 012
  • Loading branch information
mpoke authored Nov 10, 2023
1 parent 141c8e3 commit 9b9480c
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/production.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ I have...
* [ ] Updated the relevant documentation or specification
* [ ] Reviewed "Files changed" and left comments if necessary <!-- relevant if the changes are not obvious -->
* [ ] Confirmed all CI checks have passed
* [ ] If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release for both the consumer and provider
* [ ] If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

### Reviewers Checklist

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,9 @@ ICS adheres to the [trunk based development branching model](https://trunkbasedd

ICS follows [semantic versioning](https://semver.org), but with the following deviations (similar to [IBC-Go](https://github.com/cosmos/ibc-go/blob/main/RELEASES.md)):

- A library API breaking change to EITHER the provider or consumer module will result in an increase of the MAJOR version number for BOTH modules (X.y.z-provider AND X.y.z-consumer).
- A state breaking change (change requiring coordinated upgrade and/or state migration) will result in an increase of the MINOR version number for the AFFECTED module(s) (x.Y.z-provider AND/OR x.Y.z-consumer).
- Any other changes (including node API breaking changes) will result in an increase of the PATCH version number for the AFFECTED module(s) (x.y.Z-provider AND/OR x.y.Z-consumer).
- A library API breaking change will result in an increase of the MAJOR version number (X.y.z | x > 0).
- A state breaking change (change requiring coordinated upgrade and/or state migration for the consumer, the provider, or both) will result in an increase of the MINOR version number (x.Y.z | x > 0).
- Any other changes (including node API breaking changes) will result in an increase of the PATCH version number (x.y.Z | x > 0).

### Backwards Compatibility

Expand Down
10 changes: 6 additions & 4 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<!--
A release notes template that should be adapted for every release
- release: <v*.*.*>-<consumer/provider>
- release branch: release/<v*.*.x>-<consumer/provider>
- release: <v*.*.*>
- release branch: <v*.x>
- the last release: <v-last>
- the last release branch: <v-last.x>
-->

# Replicated Security <v*.*.*>-<consumer/provider> Release Notes
# Replicated Security <v*.*.*> Release Notes

<!--
Please indicate whether this release is relevant to consumers or providers.
-->
## Note this release is ONLY relevant to <consumers/providers>
***Note this release is ONLY relevant to <consumers/providers>***

## 📝 Changelog

Expand Down
5 changes: 3 additions & 2 deletions docs/docs/adrs/adr-012-separate-releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ title: Separate Releasing

* {8/18/22}: Initial draft of idea in [#801](https://github.com/cosmos/interchain-security/issues/801)
* {8/22/22}: Put idea in this ADR
* {11/10/22}: Reject this ADR

## Status

Accepted
Rejected

## Context

Expand Down Expand Up @@ -63,7 +64,7 @@ We upgrade `main` to use a new version of SDK. This is a major version bump, tri

### Negative

* Slightly more complexity.
* ~~Slightly more complexity.~~Considerably more complex to manage the ICS library.
* This solution does not allow having provider and consumer on separate versions of e.g. the Cosmos SDK

### Neutral
Expand Down

0 comments on commit 9b9480c

Please sign in to comment.