[DOCS-113] Find way to avoid need for docs/conf.yaml version maintenance per-project Created: 11/Oct/18 Updated: 13/Apr/21 Resolved: 13/Apr/21 |
|
| Status: | Closed |
| Project: | docs |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | Aluminium |
| Type: | Improvement | Priority: | Medium |
| Reporter: | Daniel Farrell | Assignee: | Thanh Ha (zxiiro) |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Description |
|
Now that project-specific docs have moved out of the docs project and to individual projects, each project has a docs/conf.yaml with a version name that needs to match the branch (Neon for master at the moment, Fluorine for stable/fluorine, etc). It's not great to have to manually do this for all the projects. Maybe we can pull it from a central place, or at least add some scripting/automation. Should also doc/handle this is in the normal branch cutting process. |
| Comments |
| Comment by Thanh Ha (zxiiro) [ 04/Nov/19 ] |
|
Using `git describe` does not work for us because our tags are not reachable from the master branch due to them being on forked branches. Unfortunately this prevents us from using the same solution as LF uses in global-jjb to handle automated versioning. |
| Comment by Thanh Ha (zxiiro) [ 04/Nov/19 ] |
|
For ODL we can parse pom.xml instead with the following code: import xml.etree.ElementTree as ET
version = ET.parse('pom.xml').getroot().find('*//{http://maven.apache.org/POM/4.0.0}version').text
release = version
|
| Comment by Thanh Ha (zxiiro) [ 04/Nov/19 ] |
|
At least for MRI projects we can use this method. |