From 7d9e660a89d8ac3e92ac2a8552f504d164b40e11 Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Fri, 10 Nov 2023 15:16:58 +0100 Subject: [PATCH] docs: reject ADR 012 (#1407) reject ADR 012 --- .github/PULL_REQUEST_TEMPLATE/production.md | 2 +- CONTRIBUTING.md | 6 +++--- RELEASE_NOTES.md | 10 ++++++---- docs/docs/adrs/adr-012-separate-releasing.md | 5 +++-- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/production.md b/.github/PULL_REQUEST_TEMPLATE/production.md index 7fe79eceb9..d8151fe707 100644 --- a/.github/PULL_REQUEST_TEMPLATE/production.md +++ b/.github/PULL_REQUEST_TEMPLATE/production.md @@ -30,7 +30,7 @@ I have... * [ ] Updated the relevant documentation or specification * [ ] Reviewed "Files changed" and left comments if necessary * [ ] 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c376c3b824..8975d37269 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index f1a6edb066..a09f9a4ba7 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,15 +1,17 @@ -# Replicated Security - Release Notes +# Replicated Security Release Notes -## Note this release is ONLY relevant to +❗ ***Note this release is ONLY relevant to *** ## 📝 Changelog diff --git a/docs/docs/adrs/adr-012-separate-releasing.md b/docs/docs/adrs/adr-012-separate-releasing.md index 386c8add29..8b65a25638 100644 --- a/docs/docs/adrs/adr-012-separate-releasing.md +++ b/docs/docs/adrs/adr-012-separate-releasing.md @@ -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 @@ -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