commit a58ef7fd2fed181f4d41f9ad6d5a1575bdabba7d
parent df537e17fa90e1db71cec770b5a91a4b01d51b7b
Author: arjoonn <arjoonn@noreply.localhost>
Date: Fri, 20 Jan 2023 15:33:00 +0000
Add howto in docs (!27)
Branch auto created by JayporeCI
```jayporeci
╔ 🟢 : JayporeCI [sha 7b13d41e20]
┏━ Docker
┃
┃ 🟢 : Jci [b2655dac] 1:13
┃ 🟢 : JciEnv [53b98f5b] 1: 6
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Jobs
┃
┃ 🟢 : black [db4f6db1] 0: 0
┃ 🟢 : pylint [aa024dce] 0: 5
┃ 🟢 : pytest [f96f70c9] 0:32
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Publish
┃
┃ 🟢 : DockerHubJci [7c7a75b6] 1: 1
┃ 🟢 : DockerHubJcienv [f4f5b7da] 1:12
┃ 🟢 : PublishDocs [ce5c4749] 0: 5
┃ 🟢 : PublishPypi [ded1e9d9] 0: 6
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
```
Co-authored-by: arjoonn sharma <arjoonn@midpathsoftware.com>
Reviewed-on: https://gitea.midpathsoftware.com/midpath/jaypore_ci/pulls/27
Diffstat:
2 files changed, 24 insertions(+), 1 deletion(-)
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -67,9 +67,32 @@ Your entire config is inside `cicd/cicd.py`. Edit it to whatever you like! A bas
p.job("Pylint", "pylint mycode/ tests/")
p.job("PyTest", "pytest tests/")
+This would produce a CI report like::
+
+ ╔ 🟢 : JayporeCI [sha edcb193bae]
+ ┏━ Pipeline
+ ┃
+ ┃ 🟢 : Black [ffcda0a9] 0: 3
+ ┃ 🟢 : Pylint [2417ad58] 0: 9
+ ┃ 🟢 : PyTest [28d4985f] 0:15
+ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+- `edcb193bae` is the SHA that the report is for.
+- `Pipeline` is the default pipeline stage.
+- 🟢 indicates that the job has passed
+- `Black`, `Pylint`, and `PyTest` are the job names.
+- `[ffcda0a9]` is the docker container ID for that job.
+- `1: 3` is the time taken by the job.
+
+
Examples
========
+Job logs / debugging
+--------------------
+
+- To see logs you can do `docker logs <container ID>`
+- To debug you can `docker exec <container ID>` while the job is running.
Dependencies in docker
----------------------
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "jaypore_ci"
-version = "0.1.12"
+version = "0.1.13"
description = ""
authors = ["arjoonn sharma <arjoonn.94@gmail.com>"]
