diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2025-04-09 11:55:41 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-04-21 21:17:02 +0100 |
commit | 5c4cf4b57362172064d2d1d290b9e02763784a45 (patch) | |
tree | 5a13d32f29e323c73e7a386a6c7f5d25799ef935 /documentation/set_versions.py | |
parent | e5577538c3161f8782e025abea05d30ad5f93139 (diff) | |
download | poky-5c4cf4b57362172064d2d1d290b9e02763784a45.tar.gz |
poky.yaml: introduce DISTRO_LATEST_TAG
Introduce the DISTRO_LATEST_TAG macro, which should always point to the
latest existing tag in the documentation, unlike DISTRO which may point
to A.B.999 to represent the tip of a branch.
This variable is needed to fix dead links in the documentation that
currently use the DISTRO macro.
Also, make DISTRO_REL_TAG use the DISTRO macro directly, to avoid
repetition, and add a DISTRO_REL_LATEST_TAG macro that has the same role
as DISTRO_LATEST_TAG but with "yocto-" prepended to it.
In set_versions.py, run the "git describe --abbrev=0 --tags
--match='yocto-*'" command to get the latest existing tag on the
currently checked out commit. Fallback to ourversion in case we didn't
find any.
(From yocto-docs rev: a85b0e500c94921f77fa7b7dbb877e4945f96d1e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/set_versions.py')
-rwxr-xr-x | documentation/set_versions.py | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/documentation/set_versions.py b/documentation/set_versions.py index 5c55f470d7..b94a7daad0 100755 --- a/documentation/set_versions.py +++ b/documentation/set_versions.py | |||
@@ -170,17 +170,29 @@ series = [k for k in release_series] | |||
170 | previousseries = series[series.index(ourseries)+1:] or [""] | 170 | previousseries = series[series.index(ourseries)+1:] or [""] |
171 | lastlts = [k for k in previousseries if k in ltsseries] or "dunfell" | 171 | lastlts = [k for k in previousseries if k in ltsseries] or "dunfell" |
172 | 172 | ||
173 | latestreltag = subprocess.run(["git", "describe", "--abbrev=0", "--tags", "--match", "yocto-*"], capture_output=True, text=True).stdout | ||
174 | latestreltag = latestreltag.strip() | ||
175 | if latestreltag: | ||
176 | if latestreltag.startswith("yocto-"): | ||
177 | latesttag = latestreltag[6:] | ||
178 | else: | ||
179 | # fallback on the calculated version | ||
180 | print("Did not find a tag with 'git describe', falling back to %s" % ourversion) | ||
181 | latestreltag = "yocto-" + ourversion | ||
182 | latesttag = ourversion | ||
183 | |||
173 | print("Version calculated to be %s" % ourversion) | 184 | print("Version calculated to be %s" % ourversion) |
185 | print("Latest release tag found is %s" % latestreltag) | ||
174 | print("Release series calculated to be %s" % ourseries) | 186 | print("Release series calculated to be %s" % ourseries) |
175 | 187 | ||
176 | replacements = { | 188 | replacements = { |
177 | "DISTRO" : ourversion, | 189 | "DISTRO" : ourversion, |
190 | "DISTRO_LATEST_TAG": latesttag, | ||
178 | "DISTRO_NAME_NO_CAP" : ourseries, | 191 | "DISTRO_NAME_NO_CAP" : ourseries, |
179 | "DISTRO_NAME" : ourseries.capitalize(), | 192 | "DISTRO_NAME" : ourseries.capitalize(), |
180 | "DISTRO_NAME_NO_CAP_MINUS_ONE" : previousseries[0], | 193 | "DISTRO_NAME_NO_CAP_MINUS_ONE" : previousseries[0], |
181 | "DISTRO_NAME_NO_CAP_LTS" : lastlts[0], | 194 | "DISTRO_NAME_NO_CAP_LTS" : lastlts[0], |
182 | "YOCTO_DOC_VERSION" : ourversion, | 195 | "YOCTO_DOC_VERSION" : ourversion, |
183 | "DISTRO_REL_TAG" : "yocto-" + ourversion, | ||
184 | "DOCCONF_VERSION" : docconfver, | 196 | "DOCCONF_VERSION" : docconfver, |
185 | "BITBAKE_SERIES" : bitbakeversion, | 197 | "BITBAKE_SERIES" : bitbakeversion, |
186 | } | 198 | } |
@@ -318,3 +330,5 @@ with open('releases.rst', 'w') as f: | |||
318 | if tag == release_series[series] or tag.startswith('%s.' % release_series[series]): | 330 | if tag == release_series[series] or tag.startswith('%s.' % release_series[series]): |
319 | f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag)) | 331 | f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag)) |
320 | f.write('\n') | 332 | f.write('\n') |
333 | |||
334 | |||