doc: dynamic version number management

Oslandia · Oct 9, 2024 · e782b2c · e782b2c
1 parent 5e4d8b7
commit e782b2c
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 7 deletions.
diff --git a/website/__pycache__/macros.cpython-312.pyc b/website/__pycache__/macros.cpython-312.pyc
diff --git a/website/docs/index.md b/website/docs/index.md
@@ -1,11 +1,11 @@
 # SFCGAL
 
-![]( assets/img/logo.svg)
+![](assets/img/logo.svg)
 
 ## Downloads
 
-[Download this project as a .zip file](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ current_version }}/SFCGAL-v{{ current_version }}.zip){ .md-button .md-button--primary }
-[Download this project as a tar.gz file](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ current_version }}/SFCGAL-v{{ current_version }}.tar.gz){ .md-button .md-button--primary }
+[Download this project as a .zip file](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ get_project_version() }}/SFCGAL-v{{ get_project_version() }}.zip){ .md-button .md-button--primary }
+[Download this project as a tar.gz file](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ get_project_version() }}/SFCGAL-v{{ get_project_version() }}.tar.gz){ .md-button .md-button--primary }
 
 ## About
 

diff --git a/website/docs/installation.md b/website/docs/installation.md
@@ -6,7 +6,7 @@ SFCGAL source code is available on the corresponding [GitLab repository](https:/
 
 The `master` branch is the development branch and has a tag for each released version.
 
-Source code of the {{ current_version }} release can be found with the tag v{{ current_version }}. You can directly download a [zip](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ current_version }}/SFCGAL-v{{ current_version }}.zip) or [tarball](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ current_version }}/SFCGAL-v{{ current_version }}.tar.gz).
+Source code of the {{ get_project_version() }} release can be found with the tag v{{ get_project_version() }}. You can directly download a [zip](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ get_project_version() }}/SFCGAL-v{{ get_project_version() }}.zip) or [tarball](https://gitlab.com/SFCGAL/SFCGAL/-/archive/v{{ get_project_version() }}/SFCGAL-v{{ get_project_version() }}.tar.gz).
 
 ## Supported platforms
 

diff --git a/website/macros.py b/website/macros.py
@@ -30,3 +30,22 @@ def include_file(filename: str) ->str:
                 return content
         except FileNotFoundError:
             return f"File not found: {filename}"
+
+    @env.macro
+    def get_project_version() -> str:
+        """Retrieve the project version from sonar-project.properties.
+
+        Returns:
+            str: The project version if found, or an error message if the file 
+                 cannot be read or the version is not specified.
+        """
+        properties_file = "../sonar-project.properties"
+        try:
+            with open(properties_file, "r", encoding="utf-8") as file:
+                for line in file:
+                    if line.startswith("sonar.projectVersion="):
+                        # Extract and return the version number
+                        return line.split("=", 1)[1].strip()
+            return "Version not found in the properties file."
+        except FileNotFoundError:
+            return f"File not found: {properties_file}"
diff --git a/website/mkdocs.yml b/website/mkdocs.yml
@@ -2,9 +2,6 @@ site_name: SFCGAL
 repo_name: "SFCGAL"
 repo_url: "https://gitlab.com/sfcgal/SFCGAL/"
 
-extra:
-  current_version: 1.5.2
-
 theme:
   name: material
   features: