readme: change note on beta releases (for RCs) #3044
Conversation
| @@ -79,38 +79,36 @@ sudo ./install-dependencies.sh && CC=clang CXX=clang++ ./build.sh | |||
|
|
|||
| For quicker dev setup, we provide a [docker image](tools/docker/README.md) with the toolchain installed. | |||
|
|
|||
| # Beta builds | |||
| # Release candidate builds | |||
There was a problem hiding this comment.
Not sure everyone knows what a release candidate build is. How about we call these "Testing" or "Non production" builds?
There was a problem hiding this comment.
This is the readme on GitHub not public docs. RC makes sense to me. Although we can say that in the description
There was a problem hiding this comment.
Pretty sure "release candidate" is a common enough name for the non-supported builds which contain expected functionality prior to the final release. Agreed we should describe it clearly in the description (along with the difference between beta builds which are not necessarily all the expected functionality as the final version).
There was a problem hiding this comment.
We might want to add a sentence like "RC builds are not recommended for production use"
| curl -1sLf \ | ||
| 'https://packages.vectorized.io/HxYRCzL4xbbaEtPi/redpanda-beta/setup.deb.sh' \ | ||
| 'https://packages.vectorized.io/E4xN1tVe3Xy60GTx/redpanda-unstable/setup.deb.sh' \ |
There was a problem hiding this comment.
I don’t get why change the upstream repo link seems like no need. What am I missing.
There was a problem hiding this comment.
i initially thought of renaming the repo but that'll break any exiting config. should we do that instead?
README.md
Outdated
|
|
||
| This is an example with the `v21.3.5-beta3` version prior to the 21.3.5 release. | ||
| This is an example with the `v21.11.1~rc1` version prior to the 21.11.1 release. |
There was a problem hiding this comment.
@ivotron from our discussion earlier today, i think this line is implying the git tag use a ~ char to separate with rc. i suggest keeping the - separator for git tags because it is more aligned with https://semver.org/ and it is expected in git tagging conventions https://git-scm.com/book/en/v2/Git-Basics-Tagging
regarding how we build debian packages with version numbers, we can replace - with ~ char in the scripts used downstream to adhere to debian's way of handling version sorting cc @BenPope
| This is an example with the `v21.11.1~rc1` version prior to the 21.11.1 release. | |
| This is an example with the `v21.11.1-rc1` version prior to the 21.11.1 release. |
There was a problem hiding this comment.
Works for me. Can we add something about testing branches? e.g.: v21.11.3-si-beta7 tagged on v21.11.x-si-testing - the first - means it's sorted before the release.
ivotron
force-pushed
the
change-betas-for-rc-in-readme
branch
from
29d1b2a
to
fa442a4
Compare
README.md
Outdated
| @@ -92,38 +92,35 @@ sudo ./install-dependencies.sh && CC=clang CXX=clang++ ./build.sh | |||
|
|
|||
| For quicker dev setup, we provide a [docker image](tools/docker/README.md) with the toolchain installed. | |||
|
|
|||
| # Beta builds | |||
| # Release candidate builds | |||
|
|
|||
| For those of us who like to live on the edge! | |||
There was a problem hiding this comment.
I would remove this. It makes it sound like using our software is dangerous and non-native english speakers might be confused about this.
[skip ci] Signed-off-by: Ivo Jimenez <ivo@redpanda.com> Co-authored-by: Andrew Hsu <xuzuan@gmail.com>
ivotron
force-pushed
the
change-betas-for-rc-in-readme
branch
from
fa442a4
to
283956d
Compare
|
thanks @vsaraswat and @coral-waters, I've removed the first sentence and added one noting that RCs shouldn't be used in production. |
| ``` | ||
| docker.vectorized.io/vectorized/redpanda:v21.3.5-beta3 | ||
| ```bash | ||
| docker pull docker.vectorized.io/vectorized/redpanda-unstable:v22.1.1-rc1 |
There was a problem hiding this comment.
i tried this but looks like a redirect rule may need to be updated:
bash$ docker pull docker.vectorized.io/vectorized/redpanda-unstable:v22.1.1-rc1
Error response from daemon: repository docker.vectorized.io/vectorized/redpanda-unstable not found: name unknown: repository name not known to registry
Update notes on beta releases (move from betas to RCs).
companion PR to: https://github.com/vectorizedio/vtools/pull/221