Clarify the state of releases vs website

apple / foundationdb

FoundationDB - the open source, distributed, transactional key-value store

https://apple.github.io/foundationdb/

Apache License 2.0

14.33k stars 1.3k forks source link

Clarify the state of releases vs website #1954

Closed brndnmtthws closed 2 years ago

brndnmtthws commented 5 years ago

Currently the website lists 6.1.8 as the latest release, but there are newer releases on GitHub. Could you please clarify what release is considered stable?

alexmiller-apple commented 5 years ago

@hgray1, I think you were working on some text to better explain the github releases vs website stable release.

@etschannen to follow up on why some of the patch releases aren't making it to the website.

mhindery commented 3 years ago

Can this please be picked up again? It's been 1.5 years. There are quite a few differences nowadays and it's incredibly confusing to find out where to look for the current state, and practically impossible to find release notes and relevant changes via github since the releases don't contain a text with changelogs.

E.g. the latest blog post on the website is from the 28th of October 2019, announcing the 6.2.7 release.

The release notes however have release 6.2.19.

And on Github the latest release is actually 6.3.9

sfc-gh-abeamon commented 3 years ago

I strongly agree this needs to be cleaned up.

One note that I'll add for whoever takes that on is that it seems there are release notes links that point to different versions of the document. The one linked to from our homepage points to a more current one with 6.2.28.

The one linked in the comment above only goes up through 6.2.19.

xumengpanda commented 3 years ago

Thanks for bring this up!

Release note can be accessed at https://apple.github.io/foundationdb/release-notes.html To figure out which version is production-ready, the conversion is as follows:

The version shown at https://www.foundationdb.org/download/ is the production-ready version recommended to use.
In the dropdown box at https://www.foundationdb.org/download/, if the version is lower than the recommended production-ready version, that's the old production-ready version. If the version is higher, it is alpha test version, which we are using to test in our own production clusters before we officially suggest the community to use.
In the version number "x.y.z", the last digit "z" is patch version. "z" may not be 1 for the first official release version for a major release.

We should fix it. At the least, we should put the explanation on the website. @AlvinMooreSr

sfc-gh-abeamon commented 3 years ago

@xumengpanda Your linked release notes also seems to be to an older version. I'm not sure exactly why that's happening, but it could be related to the change we made so that each version's release notes document has the version number in the filename.

One other comment I'll add is that the 6.3 releases are still technically in pre-release until they've been adequately tested and determined ready for production use. We had been marking these releases as prerelease in GitHub (which we can see up through 6.3.5), but I think this label may also need to be applied to newer 6.3.x releases too.

ammolitor commented 2 years ago

Release assets are moved to GitHub. The website has been updated to link back to GitHub.