From f2d0150a8bbfda32deeec92abd41ccfb5784a5f7 Mon Sep 17 00:00:00 2001 From: Jeff Lee Date: Thu, 2 Mar 2017 11:40:54 -0800 Subject: [PATCH 1/5] docs/internal: unify historical package branches --- docs/internal/package-tags-branches.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/internal/package-tags-branches.md b/docs/internal/package-tags-branches.md index 120a1d3fed..c556e8d1de 100644 --- a/docs/internal/package-tags-branches.md +++ b/docs/internal/package-tags-branches.md @@ -12,23 +12,23 @@ - `sdk-node` - `sdk-ruby` -## Basic scheme +## Version branches -Every release has a **tag** that specifies the major, minor, and build versions, e.g.: +Every major/minor version pair will have its own branch named `-.x`, e.g: -- `chain-core-server-1.1.0` -- `sdk-ruby-1.0.2` +- `1.0.x` +- `1.1.x` -If a point release is necessary for a package, we should create a new major-minor version **branch** e.g.: +Version branches should be the target for point release updates across all packages. These updates should be as conservative as possible. Our [versioning scheme](../core/reference/versioning.md) is such that it should always be safe to deploy artifacts from the tip of each package branch. -- `chain-core-server-1.1.x` -- `sdk-ruby-1.0.x` +## Release tags -Note that there's a `.x` suffix to distinguish the branch name from the corresponding `.0` release. +Every package release has a **tag** that specifies the package name and its major, minor, and build versions, e.g.: -Updates to these branches should be as conservative as possible. Our [versioning scheme](../core/reference/versioning.md) is such that it should always be safe to deploy artifacts from the tip of each package branch. +- `chain-core-server-1.1.0` +- `sdk-ruby-1.0.2` -Naturally, release tags should live on their relevant branches, e.g.: +Naturally, release tags should live on their relevant version branches, e.g.: -- `chain-core-server-1.1.0` is on the `chain-core-server-1.1.x` branch -- `sdk-ruby-1.0.2` is on the `sdk-ruby-1.0.x` branch +- `chain-core-server-1.1.1` is on the `1.1.x` branch +- `sdk-ruby-1.0.2` is on the `1.0.x` branch From ffc0056a22d11a1032a182720df40e6914d9be32 Mon Sep 17 00:00:00 2001 From: Jeff Lee Date: Thu, 2 Mar 2017 11:46:19 -0800 Subject: [PATCH 2/5] edits --- docs/internal/package-tags-branches.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/internal/package-tags-branches.md b/docs/internal/package-tags-branches.md index c556e8d1de..574e7c4481 100644 --- a/docs/internal/package-tags-branches.md +++ b/docs/internal/package-tags-branches.md @@ -19,7 +19,9 @@ Every major/minor version pair will have its own branch named `-.x - `1.0.x` - `1.1.x` -Version branches should be the target for point release updates across all packages. These updates should be as conservative as possible. Our [versioning scheme](../core/reference/versioning.md) is such that it should always be safe to deploy artifacts from the tip of each package branch. +Version branches act as the merge base for point release updates across all packages. We should ensure that the tip of each version branch maintains cross-compatibility across packages, per our [versioning scheme](../core/reference/versioning.md). + +Updates to the version branches should be as conservative as possible. ## Release tags From 75be063e452e9eacb55b5223afdfaf79cd748826 Mon Sep 17 00:00:00 2001 From: Jeff Lee Date: Thu, 2 Mar 2017 11:58:14 -0800 Subject: [PATCH 3/5] edits --- docs/internal/package-tags-branches.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/internal/package-tags-branches.md b/docs/internal/package-tags-branches.md index 574e7c4481..f677bc4b9b 100644 --- a/docs/internal/package-tags-branches.md +++ b/docs/internal/package-tags-branches.md @@ -19,9 +19,11 @@ Every major/minor version pair will have its own branch named `-.x - `1.0.x` - `1.1.x` -Version branches act as the merge base for point release updates across all packages. We should ensure that the tip of each version branch maintains cross-compatibility across packages, per our [versioning scheme](../core/reference/versioning.md). +Version branches act as the merge base for point release updates across all packages, and should start with the commit corresponding to `chain-core-server-..0`.* -Updates to the version branches should be as conservative as possible. +Updates to the version branches should be as conservative as possible. We should ensure that the tip of each version branch maintains cross-compatibility across packages, per our [versioning scheme](../core/reference/versioning.md). + +* `1.0.x` is an exception, since it precedes this branching scheme. ## Release tags From fb1910f5554873d818aa5a0a97bcb570d3442189 Mon Sep 17 00:00:00 2001 From: Jeff Lee Date: Thu, 2 Mar 2017 12:12:16 -0800 Subject: [PATCH 4/5] edits --- docs/internal/package-tags-branches.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/internal/package-tags-branches.md b/docs/internal/package-tags-branches.md index f677bc4b9b..0781d0ec46 100644 --- a/docs/internal/package-tags-branches.md +++ b/docs/internal/package-tags-branches.md @@ -16,14 +16,14 @@ Every major/minor version pair will have its own branch named `-.x`, e.g: -- `1.0.x` -- `1.1.x` +- `1.0-stable` +- `1.1-stable` -Version branches act as the merge base for point release updates across all packages, and should start with the commit corresponding to `chain-core-server-..0`.* +Version branches act as the merge base for point release updates across all packages, and should start with the commit corresponding to `chain-core-server-..0`.1 Updates to the version branches should be as conservative as possible. We should ensure that the tip of each version branch maintains cross-compatibility across packages, per our [versioning scheme](../core/reference/versioning.md). -* `1.0.x` is an exception, since it precedes this branching scheme. +1 `1.0-stable` is an exception, since it precedes this branching scheme. ## Release tags From e8fb4e62b1eb038115fe9b2fbf83c7c8632faab9 Mon Sep 17 00:00:00 2001 From: Jeff Lee Date: Thu, 2 Mar 2017 12:12:34 -0800 Subject: [PATCH 5/5] edits --- docs/internal/package-tags-branches.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/internal/package-tags-branches.md b/docs/internal/package-tags-branches.md index 0781d0ec46..4ff3948a6e 100644 --- a/docs/internal/package-tags-branches.md +++ b/docs/internal/package-tags-branches.md @@ -34,5 +34,5 @@ Every package release has a **tag** that specifies the package name and its majo Naturally, release tags should live on their relevant version branches, e.g.: -- `chain-core-server-1.1.1` is on the `1.1.x` branch -- `sdk-ruby-1.0.2` is on the `1.0.x` branch +- `chain-core-server-1.1.1` is on the `1.1-stable` branch +- `sdk-ruby-1.0.2` is on the `1.0-stable` branch