commit 64fe7a5ee05c16cc490c1b8e5ff15ad84b71c09c
parent 5a22e149bc23a3f7aa53d4564df4a6bf195c1110
Author: arjoonn <arjoonn@noreply.localhost>
Date: Fri, 24 Mar 2023 17:20:00 +0000
Add mermaid support in docs (!76)
Reviewed-on: https://gitea.midpathsoftware.com/midpath/jaypore_ci/pulls/76
╔ 🟡 : JayporeCI [sha e5f4622887]
┏━ build-and-test
┃
┃ 🔵 : JciEnv [e0a6442e] 0: 1
┃ 🟡 : Jci [ ] --:-- ❮-- ['JciEnv']
┃ 🟡 : black [ ] --:-- ❮-- ['JciEnv']
┃ 🟡 : install-test [ ] --:-- ❮-- ['JciEnv']
┃ 🟡 : pylint [ ] --:-- ❮-- ['JciEnv']
┃ 🟡 : pytest [ ] --:-- ❮-- ['JciEnv']
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Publish
┃
┃ 🟡 : DockerHubJci [ ] --:--
┃ 🟡 : DockerHubJcienv [ ] --:--
┃ 🟡 : PublishDocs [ ] --:--
┃ 🟡 : PublishPypi [ ] --:--
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Diffstat:
4 files changed, 53 insertions(+), 1 deletion(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,6 +17,7 @@ extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx_rtd_theme",
+ "sphinxcontrib.mermaid",
]
templates_path = ["_templates"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -101,6 +101,19 @@ Concepts
Pipeline config
***************
+.. mermaid::
+
+ sequenceDiagram
+ autonumber
+ loop Pipeline execution
+ Pipeline ->> Executor: docker run [n jobs]
+ Executor -->> Pipeline: docker inspect [k jobs]
+ Pipeline ->> Reporter: Pipeline status
+ Reporter -->> Pipeline: Rendered report
+ Pipeline ->> Remote: Publish report
+ Remote -->> Pipeline: ok
+ end
+
1. A pipeline is defined inside a python file that imports and uses **jaypore_ci**.
- It can also import other libraries / configs. Do whatever your usecase needs.
2. A config starts with creating a :class:`~jaypore_ci.jci.Pipeline` instance. Everything happens inside this context.
@@ -382,3 +395,28 @@ Reference
Changelog
=========
+0.2.29
+------
+
+- 🐞: When gitea token does not have enough scope log correctly and exit
+
+0.2.28
+------
+
+- 🐞: When there are multiple (push) remotes, Jaypore CI will pick the first one and use that.
+
+0.2.27
+------
+
+- 🎁: Jobs older than 1 week will be removed before starting a new pipeline.
+
+0.2.26
+------
+
+- ⚙️: The Dockerfile inside `cicd/Dockerfile` now requires a build arg that specifies the version of Jaypore CI to install.
+
+0.2.25
+------
+
+- 🎁: A dockerfile is now used to send context of the codebase to the docker daemon instead of directly mounting the code. This allows us to easily use remote systems for jobs
+
diff --git a/poetry.lock b/poetry.lock
@@ -1114,6 +1114,18 @@ files = [
test = ["flake8", "mypy", "pytest"]
[[package]]
+name = "sphinxcontrib-mermaid"
+version = "0.8.1"
+description = "Mermaid diagrams in yours Sphinx powered docs"
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "sphinxcontrib-mermaid-0.8.1.tar.gz", hash = "sha256:fa3e5325d4ba395336e6137d113f55026b1a03ccd115dc54113d1d871a580466"},
+ {file = "sphinxcontrib_mermaid-0.8.1-py3-none-any.whl", hash = "sha256:15491c24ec78cf1626b1e79e797a9ce87cb7959cf38f955eb72dd5512aeb6ce9"},
+]
+
+[[package]]
name = "sphinxcontrib-qthelp"
version = "1.0.3"
description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document."
@@ -1358,4 +1370,4 @@ testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more
[metadata]
lock-version = "2.0"
python-versions = "^3.8"
-content-hash = "524db2ef19c7ef454826113dd7c111e43592aa1c288db731a4c2a7951ecf7ac3"
+content-hash = "7433dfdb5a52ecc76bc584d9453c1c4449e7b7659bdc653e6704470ae53f537d"
diff --git a/pyproject.toml b/pyproject.toml
@@ -25,6 +25,7 @@ coverage = "^7.0.5"
pytest-profiling = "^1.7.0"
hypothesis = "^6.68.2"
sphinx-rtd-theme = "^1.2.0"
+sphinxcontrib-mermaid = "^0.8.1"
[build-system]
requires = ["poetry-core>=1.0.0"]
