Mention version and coverage in docs (!47)

Branch auto created by JayporeCI ```jayporeci ╔ 🟡 : JayporeCI [sha d049138] ┏━ build_and_test ┃ ┃ 🟢 : JciEnv [7b2ff94a] 0: 2 ┃ 🟢 : Jci [c9729241] 0: 6 ❮-- ['JciEnv'] ┃ 🟢 : black [664d4593] 0: 0 ❮-- ['JciEnv'] ┃ 🟢 : pylint [46a4e992] 0: 7 ❮-- ['JciEnv'] ┃ 🟢 : pytest [b9af077f] 1:18 Cov: 81% ❮-- ['JciEnv'] ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ┏━ Publish ┃ ┃ 🔵 : DockerHubJci [e9629d5f] 0:19 ┃ 🟢 : DockerHubJcienv [b0085174] 0:11 ┃ 🔵 : PublishDocs [618e30ab] 0:16 ┃ 🔴 : PublishPypi [25579b49] 0: 4 v0.2.18 ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ``` Co-authored-by: arjoonn sharma <[email protected]> Reviewed-on: https://gitea.midpathsoftware.com/midpath/jaypore_ci/pulls/47
theSage21 · Feb 22, 2023 · 3130241 · 3130241
1 parent 58c9aaa
commit 3130241
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,5 @@
-# Jaypore CI
 
-
-![JayporeCI](docs/source/_static/logo.png)
+# ![JayporeCI](docs/source/_static/logo80.png) Jaypore CI
 
 Documentation is at : https://www.jayporeci.in
 

diff --git a/cicd/run_tests.sh b/cicd/run_tests.sh
@@ -10,6 +10,10 @@ main() {
     coverage html
     coverage report
     echo "Cov: $(coverage report --format=total)%" > "/jaypore_ci/run/pytest.txt"
+    # Mark info in jci docs
+    # .. |Product| replace:: SoftTech Analyzer
+    echo -e "\n.. |coverage| replace:: $(coverage report --format=total)%\n" >> "/jaypore_ci/run/docs/source/index.rst"
+    echo -e "\n.. |package_version| replace:: $(poetry version | awk '{print $2}')\n" >> "/jaypore_ci/run/docs/source/index.rst"
 }
 
 (main)

diff --git a/docs/source/_static/logo80.png b/docs/source/_static/logo80.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,10 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Jaypore CI
-==========
+|logo|
+======
+
+- **Jaypore CI** is a *small*, *very flexible*, and *powerful* system for automation within software projects.
+- Coverage : |coverage|
+- Version  : |package_version| on `PyPi <https://pypi.org/project/jaypore-ci/>`_
 
-**Jaypore CI** is a *small*, *very flexible*, and *powerful* system for automation within software projects.
 
 
 TLDR
@@ -388,3 +391,7 @@ Reference
 
    reference/modules.rst
 
+.. |logo| image:: _static/logo80.png
+   :width: 80
+   :alt: Jaypore CI logo
+   :align: middle
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,10 @@
 [tool.poetry]
 name = "jaypore_ci"
-version = "0.2.14"
+version = "0.2.18"
 description = ""
 authors = ["arjoonn sharma <[email protected]>"]
+homepage = "https://www.jayporeci.in/"
+documentation = "https://www.jayporeci.in/"
 
 [tool.poetry.dependencies]
 python = "^3.8"