From 900a7873bf709d2ca73cc7094c3a3184d8b2d563 Mon Sep 17 00:00:00 2001 From: Gabryel Reyes Date: Mon, 15 Jul 2024 17:07:51 +0200 Subject: [PATCH 1/3] Added deployment diagram #8 --- README.md | 4 +++ doc/uml/deployment.puml | 78 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+) create mode 100644 doc/uml/deployment.puml diff --git a/README.md b/README.md index 8029457..c57748a 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,10 @@ pyMetricCli requires an adapter file to be supplied by the user. This shall cont An example adapter can be found [here](examples/adapter/adapter.py). +### Deployment + +![deployment](https://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/NewTec-GmbH/pyMetricCli/main/doc/uml/deployment.puml) + ## Usage Show help information: diff --git a/doc/uml/deployment.puml b/doc/uml/deployment.puml new file mode 100644 index 0000000..30023f1 --- /dev/null +++ b/doc/uml/deployment.puml @@ -0,0 +1,78 @@ +@startuml DeploymentDiagram + +node "Apache Superset"<> as superset + +database "DB Server" { + component "Database" as supersetDb + + note bottom of supersetDb + The database is project specific, means + one database per project. + end note + + component "Database" as jiraDb +} + +node "Polarion"<> as polarion +database "SVN Repository" as svnRepo + +node "JIRA"<> as jira + +interface "REST API" as supersetRestApi +interface "REST API" as jiraRestApi +interface "SOAP API" as polarionSoapApi + +superset --- supersetRestApi +jira --- jiraRestApi +jira -- jiraDb +polarion --- polarionSoapApi +polarion -- svnRepo + +superset -- supersetDb + +node "Continuous Integration Server"<> { + + package "scripts" { + component "pyJiraCli" as pyJiraCli + component "pyPolarionCli" as pyPolarionCli + component "pySupersetCli" as pySupersetCli + component "pyMetricCli" as pyMetricCli + component "pyMetricCli_Adapter" as adapter + + pyJiraCli <.. pyMetricCli: <> + pyPolarionCli <.. pyMetricCli: <> + pySupersetCli <.. pyMetricCli: <> + pyMetricCli *--> adapter + + note right of pyMetricCli + Called by CI cyclic to generate + metrics. + end note + + note right of adapter + Is project specific. + Called by CI cyclic to generate + metrics. + end note + } +} + +jiraRestApi )-- pyJiraCli: <> +polarionSoapApi )-- pyPolarionCli: <> + +supersetRestApi )-- pySupersetCli: <> + +note top of superset + Report frontend for project metrics. +end note + +note top of jira + Issue tracking system. +end note + +note top of polarion + Requirements management. +end note + + +@enduml \ No newline at end of file From c7c1682a16583a289164aa140838956b23b85b89 Mon Sep 17 00:00:00 2001 From: Gabryel Reyes Date: Tue, 16 Jul 2024 16:58:19 +0200 Subject: [PATCH 2/3] Fixed badges #7 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c57748a..3a6f2ff 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics. -[![License](https://img.shields.io/badge/license-bsd-3.svg)](https://choosealicense.com/licenses/bsd-3-clause/) [![Repo Status](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip) [![CI](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml/badge.svg)](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml) +[![License](https://img.shields.io/badge/license-bsd-3.svg)](https://choosealicense.com/licenses/bsd-3-clause/) [![Repo Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![CI](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml/badge.svg)](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/test.yml) - [Installation](#installation) - [Overview](#overview) From d24b535d2f5eb4f532ddfb4ef7bd9d934a874670 Mon Sep 17 00:00:00 2001 From: Gabryel Reyes <66941456+gabryelreyes@users.noreply.github.com> Date: Tue, 16 Jul 2024 17:03:19 +0200 Subject: [PATCH 3/3] Bump version to v1.0.1 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 40aa221..9339176 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "pyMetricCli" -version = "1.0.0" +version = "1.0.1" description = "pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics." readme = "README.md" requires-python = ">=3.9"