latest docs should point to the latest non-experimental release, not master

Question

latest docs should point to the latest non-experimental release, not master

mcollina opened this issue 4 years ago · comments

Currently in the https://www.fastify.io/ top banner, we point to docs of master.
With the upcoming v3 release, this would soon be experimental/alpha. So, we should point the docs to the latest stable version.

Matteo Collina · Answer 1 · Mon Mar 09 2020 16:27:36 GMT+0800 (China Standard Time)

cc @lmammino

Luciano Mammino · Answer 2 · Wed Mar 11 2020 04:16:47 GMT+0800 (China Standard Time)

Let me review the current logic. As far as I remember it is based on branches and tags, so it might just work as it is. I'll reply back here as soon as I have more clarity or some questions.

(Apologies for the delay, very busy days lately)

Luciano Mammino · Answer 3 · Wed Mar 11 2020 04:44:34 GMT+0800 (China Standard Time)

Ok, I think I have now clear the current approach:

We download all the releases after a given release (using the GitHub releases endpoint). Currently, we download all from most recent until 1.13.x.
We also download the current master and we mark it a master.
The latest release is determined as the "highest" release after master as dictated by a dedicated sorting function.

If we do a GitHub release called 3.x.y that will become the latest. Is this something we don't want? Can you describe a bit more how do you plan to organise the release of v3 over time? Once we have that defined I should be able to simulate releases, test and adjust the code if needed.

Matteo Collina · Answer 4 · Wed Mar 11 2020 06:00:15 GMT+0800 (China Standard Time)

It's not working like that: latest is master right now.

We will release v3.0.0-alpha.0 and so on.

Luciano Mammino · Answer 5 · Wed Mar 11 2020 06:22:24 GMT+0800 (China Standard Time)

Will master be v3.0.0-alpha.0 as soon as v3.0.0-alpha.0 is released?

Or do you plan to keep 3.x in its own branch?

Matteo Collina · Answer 6 · Wed Mar 11 2020 06:40:47 GMT+0800 (China Standard Time)

I think so, yes. However master should never be "latest" Il 10 mar 2020, 23:22 +0100, Luciano Mammino <notifications@github.com>, ha scritto:

…

Will master be v3.0.0-alpha.0 as soon as v3.0.0-alpha.0 is released? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

Luciano Mammino · Answer 7 · Wed Mar 11 2020 16:55:36 GMT+0800 (China Standard Time)

ok, thanks!

Just to clarify: latest will be latest stable (2.x) or any latest (highest) version (3.x)?

In other words, do we need to start tracking what's stable and what's beta and treat them differently?

Matteo Collina · Answer 8 · Wed Mar 11 2020 17:28:51 GMT+0800 (China Standard Time)

Any latest version that does not have a -something.somethingelse at the end.

Luciano Mammino · Answer 9 · Wed Mar 11 2020 17:34:34 GMT+0800 (China Standard Time)

Sounds good. I'll try to find some time to make the necessary changes. When do you expect to ship 3.0.x?

Matteo Collina · Answer 10 · Wed Mar 11 2020 17:38:23 GMT+0800 (China Standard Time)

I think we'll ship ready to ship an alpha in the next few weeks.

Luciano Mammino · Answer 11 · Tue Mar 17 2020 20:56:04 GMT+0800 (China Standard Time)

Started working on this. Also found a bug whereby we might have missed releases as we look only at the first page of the releases API call 😓

Doing some testing and refactoring, it might take me a bit but I hope I will have the PR open by the end of the week