docs publishing CI Action for 3 6 x micro releases #12716
Conversation
vcidst
requested review from
a team,
sanchariGr and
ancalita
and removed request for
a team
docs/docs/markers.mdx
Outdated
| @@ -14,7 +14,7 @@ This feature is currently experimental and might change or be removed in the fut | |||
|
|
|||
| ::: | |||
|
|
|||
| :::danger | |||
| :::danger Deprecated! | |||
There was a problem hiding this comment.
Tiny change here because the banner currently reads "Danger" at https://rasa.com/docs/rasa/markers/
There was a problem hiding this comment.
I'd remove the exclamation point 🙏🏻
There was a problem hiding this comment.
Done, removed the exclamation point
scripts/evaluate_release_tag.py
Outdated
| @@ -51,6 +55,11 @@ def should_build_docs(tag: Version) -> bool: | |||
| latest_version = non_alpha_releases[-1] | |||
| print(f"The latest non-alpha/rc/nightly tag is {latest_version}.") | |||
|
|
|||
| non_beta_releases = filter_non_beta_relases(non_alpha_releases) | |||
There was a problem hiding this comment.
Should we actually consolidate filter_non_alpha_releases and filter_non_beta_releases to a function that filters for GA releases? rather than have two functions with similar end goal/use case?
There was a problem hiding this comment.
It depends if we want to allow builds on the beta versions like 3.7.0b3? If yes, then I can do further changes. I'm also confused if the phrasing of non-alpha/rc/nightly is intentional to not include beta or did they just mean latest GA version?
There was a problem hiding this comment.
if we want to allow builds on the beta versions like 3.7.0b3
Not sure either, I think sometimes betas come with docs changes and they should be indeed built, @m-vdb do you agree?
if the phrasing of non-alpha/rc/nightly is intentional to not include beta
I think they just meant fetch the latest GA version (before we weren't doing that many betas really), but maybe wait for @sanchariGr to confirm? I think she's made changes to this script before.
There was a problem hiding this comment.
we can't really build docs for beta and don't need to. Betas are cut from main, the docs will be visible on the /next/ URL in our doc website. No need to specifically build docs for betas/alphas, etc... because the docs for main are built with every push to main
the wording is confusing also because before, we didn't do betas
There was a problem hiding this comment.
I think we can bucket releases into 2 categories:
- pre-releases: nightly, alpha, beta, rcs
- general availability releases: micros, minor, major
There was a problem hiding this comment.
Got it, I've simplified the function now with some cleanup
| @@ -63,9 +72,11 @@ def should_build_docs(tag: Version) -> bool: | |||
| elif tag >= latest_version: | |||
There was a problem hiding this comment.
Shouldn't this update to tag >= latest_version_non_beta?
There was a problem hiding this comment.
Yes, simplified the function now
…' of github.com:RasaHQ/rasa into ATO-1331-docs-publishing-fails-for-3-6-x-micro-releases
scripts/evaluate_release_tag.py
Outdated
| elif tag >= latest_version: | ||
| print(f"Tag {tag} is the latest version. Docs should be built.") | ||
| need_to_build_docs = True | ||
| elif tag.minor == latest_version_non_beta.minor and tag >= latest_version_non_beta: |
There was a problem hiding this comment.
if the sorting follows the semver sorting, then definitely this can be removed. If not, then we need to keep it. Have you checked?
There was a problem hiding this comment.
I had added these lines and these checks didn't exist before, so I'm assuming that the sorting follows semver sorting
|
@vcidst we also have a test for this script , can you also please modify that?https://github.com/RasaHQ/rasa/blob/main/tests/scripts/test_evaluate_release_tag.py |
|
🚀 A preview of the docs have been deployed at the following URL: https://12716--rasahq-docs-rasa-v2.netlify.app/docs/rasa |
vcidst
deleted the
ATO-1331-docs-publishing-fails-for-3-6-x-micro-releases
branch
Proposed changes:
Docs should be built on beta tags like3.7.0b23.6.6Status (please check what you already did):
black(please check Readme for instructions)