summaryrefslogtreecommitdiffstats
path: root/documentation/set_versions.py
AgeCommit message (Collapse)Author
2022-04-26set_versions: update for 4.0 releaseMichael Halstead
Uncomment langdale lines to bump the version. (From yocto-docs rev: b4cf85ac951b1d09b8698effaf62ba052e772eac) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25docs: sphinx-static: switchers.js.in: fix broken switcher for branchesQuentin Schulz
The switcher expects URL subpath to match the "release" used by sphinx to build the documentation. Branches, however, are put in a subpath after their name (e.g. dunfell) while sphinx sets the "release" to X.Y.999. This means the switcher cannot replace correctly the path to switch between releases/versions. Let set_versions.py inject the list of release names into the switchers.js.in file so it can check whether the subpath is one of the release names in which case it needs to be stripped. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 5ef3d129b8d0d8ae98a694103930988a46285525) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25docs: set_versions.py: mark as obsolete only branches and old tags from ↵Quentin Schulz
obsolete releases Branches are identified by their .999 version suffix which means they will never be matched in the forloop above this git context. Therefore, branches will match the condition. However, branches are not necessarily obsolete (e.g. dunfell, honister and kirkstone today), so let's mark as obsolete the branches which are from obsolete releases. Old tags of currently supported releases are not defined as obsolete but outdated, therefore using the series to which they belong like it is done for branches is enough for obsolescence detection. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 7181a432da18b47608784363d243ea39b80be1ed) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25docs: update Bitbake objects.inv location for master branchQuentin Schulz
master branch of Bitbake is now located at docs.yoctoproject.org/dev instead of docs.yoctoproject.org so let's update the switchers and set_versions.py to reflect that change. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 18338292d99ed236e2bac6e73a5152ef11c4a9e5) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25docs: set_versions.py: fix latest version of an active release shown as obsoleteQuentin Schulz
ourseries can be an active release and therefore shouldn't be marked as obsolete. By adding ourseries to activereleases, it is impossible to know if ourseries is actually an active release or not. Instead let's loop on the active releases with ourseries too (only if it's not active release, otherwise it'd appear twice). Fixes: 6f40ef56054ec "docs: set_versions.py: add information about obsolescence of a release" Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: f16b633211b97b2cdf2c65d83c99cd3853d2bb5c) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25docs: set_versions.py: fix latest release of a branch being shown twice in ↵Quentin Schulz
switchers.js versions array is supposed to store the latest version of all active releases. However, in the loop it is reassigned and therefore, the check on whether our version is already in the versions array will always return false (except for the latest version of the last active release) and write our version again in the list. By using a local variable for the logic instead of versions array, the check now works properly. Fixes: f2b069be8c307 "set_versions: Various improvements" Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 36a088c8c99dd37f5ca07ec8f90f2c51ef8b36f2) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19docs: set_versions.py: add information about obsolescence of a releaseQuentin Schulz
This adds support for marking releases as obsolete to make the detection algorithm smarter (in a later commit) than just checking if it's older than dunfell. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 6f40ef56054ecbd3d8b7310d748c1af78a689add) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31set_versions/switchers: Drop versions shown to the active releasesRichard Purdie
I believe we should only be showing the "active" versions in the switchers base list of releases to show. Zeus and warrior are old and no longer actively maintained and we don't suggest new users use them. gatesgarth is also outside it's support window. I therefore propose removing these leaving us with dev, honister, hardknott, dunfell (LTS). In addition, any release that is selected will be shown, along with any later release in that release series. People can still navigate to the older docs using the releases list or by direct URL but this highlights to users which releases we'd expect/encourage them to be using. (From yocto-docs rev: 5bcd6a632ba2ebace9c65fe8529f8f1de40226ce) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23set_versions: Correct devbranch comparisionRichard Purdie
Correct the previous commit since we need to compare against ourseries rather than ourbranch since devbranch would match against the series, not the branch. (From yocto-docs rev: 57f5ce5fe427e5387f6ac85225137463e51e5643) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23set_versions: Handle dev branch in switchers correctlyRichard Purdie
The dev branch is being displayed in switchers under two different headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that. (From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23Revert "set_versions/switchers: Drop versions shown to the active releases"Richard Purdie
This reverts commit bf4e51fe5fad936f8b0e55cb49e07b18498f1837.
2022-03-23Revert "set_versions: Handle dev branch in switchers correctly"Richard Purdie
This reverts commit f7d853366470d1342e962c9d7164683a40dc0d7e.
2022-03-23set_versions/switchers: Drop versions shown to the active releasesRichard Purdie
I believe we should only be showing the "active" versions in the switchers base list of releases to show. Zeus and warrior are old and no longer actively maintained and we don't suggest new users use them. gatesgarth is also outside it's support window. I therefore propose removing these leaving us with dev, honister, hardknott, dunfell (LTS). In addition, any release that is selected will be shown, along with any later release in that release series. People can still navigate to the older docs using the releases list or by direct URL but this highlights to users which releases we'd expect/encourage them to be using. (From yocto-docs rev: fdcdc50f3abf10aa702c958b8ba7ab6b19c57bff) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23set_versions: Handle dev branch in switchers correctlyRichard Purdie
The dev branch is being displayed in switchers under two different headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that. (From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23set_versions: Various improvementsRichard Purdie
- Allow specifying the version from the commandline - Add all previous release series/version mappings (to support transitions branch) - Add poky mapping for 3.4 as some releases erronously use it - Improve git branch 'guessing' code to work properly - Handle poky '.0' release mappings correctly - Only write poky.yaml if poky.yaml.in exists - Ensure older non-active releases are shown in the switchers.js release list. - Ensure current version and current release series are shown in switcher. (From yocto-docs rev: f2b069be8c307e3efe518f5d9bb1e6e705b96554) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23set_versions/switchers.js: Allow switchers.js version information to be ↵Richard Purdie
autogenerated A horrible blunt hammer approach to updating the version information in switchers.js based on the available tag information. To merge and work correctly, this will need a change to the autobuilder-helper docs generation code to pull the swicthers.js and script from master, then to run the script. That should hopefully remove the need for other patching even on old docs branches though. (From yocto-docs rev: dc858c8b2ffdb792fe8cef05fab3d752aa858f78) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23set_versions: Add support for setting POKYVERSION found in older releasesRichard Purdie
(From yocto-docs rev: 9c7a4318920d468cca10448901868bad080cd895) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23conf.py/set_versions/poky.yaml: Set version in conf.py from poky.yamlRichard Purdie
Allow conf.py to read the versions it needs from poky.yaml and have set_versions.py write this out. This means we don't have to change as many files when making new releases. (From yocto-docs rev: bfe74c67f327f0c6445cb4129ee0c32db022b95a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23Makefile/set_versions: Allow poky.yaml to be autogeneratedRichard Purdie
Use a script to generate the branch/tag information inside poky.yaml. If the branch isn't a known release branch, include git magic to find the closest matching release branch we know about. (From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>