From fde5061bf3817f8acb20b78584d6b91c4549c9ec Mon Sep 17 00:00:00 2001 From: ansgarz Date: Fri, 12 Jan 2024 11:34:38 +0100 Subject: [PATCH 1/4] update docs --- doc/CredentialsMappin.md | 7 ++++++- doc/ReleaseMixin.md | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/CredentialsMappin.md b/doc/CredentialsMappin.md index 5c2fe92..78490b0 100644 --- a/doc/CredentialsMappin.md +++ b/doc/CredentialsMappin.md @@ -35,7 +35,12 @@ classDiagram | name | name in context of build & ENV | - | | ## Example Usage -### build.py + +### Example project + +A complete example project you can find on: https://repo.prod.meissa.de/meissa/buildtest + +### Example of a build.py ```python from os import environ diff --git a/doc/ReleaseMixin.md b/doc/ReleaseMixin.md index 6b4bbb6..5d58f07 100644 --- a/doc/ReleaseMixin.md +++ b/doc/ReleaseMixin.md @@ -26,9 +26,9 @@ classDiagram ## Input | name | description | default | -| ----------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------- | +| ----------------------------- |-----------------------------------------------------------------------------------------------------------------------| --------------- | | release_type | one of MAJOR, MINOR, PATCH, NONE | "NONE" | -| release_main_branch | the name of your trank | "main" | +| release_main_branch | the name of your trunk | "main" | | release_primary_build_file | path to the build file having the leading version info (read & write). Valid extensions are .clj, .json, .gradle, .py | "./project.clj" | | release_secondary_build_files | list of secondary build files, version is written in. | [] | | release_artifact_server_url | Optional: The base url of your forgejo/gitea instance to publish a release tode | | From 72cd6a65d2b91ecc1eec84d657650395b8e003fa Mon Sep 17 00:00:00 2001 From: ansgarz Date: Fri, 26 Jan 2024 10:37:07 +0100 Subject: [PATCH 2/4] add link to example project to README.md --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1a3c411..a677461 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![Slack](https://img.shields.io/badge/chat-clojurians-green.svg?style=flat)](https://clojurians.slack.com/messages/#dda-pallet/) | [team@social.meissa-gmbh.de team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org) -![release prod](https://github.com/DomainDrivenArchitecture/dda-devops-build/workflows/release%20prod/badge.svg) dda-devops-build integrates all the tools we use to work with clouds & provide some nice functions around. @@ -94,17 +93,9 @@ pip3 install -r requirements.txt export PATH=$PATH:~/.local/bin ``` -## Reference +## Example Project -* [DevopsBuild](./doc/DevopsBuild.md) -* [DevopsImageBuild](./doc/DevopsImageBuild.md) -* [DevopsTerraformBuild](./doc/DevopsTerraformBuild.md) - * [AwsProvider](doc/DevopsTerraformBuildWithAwsProvider.md) - * [DigitaloceanProvider](doc/DevopsTerraformBuildWithDigitaloceanProvider.md) - * [HetznerProvider](doc/DevopsTerraformBuildWithHetznerProvider.md) -* [ReleaseMixin](./doc/ReleaseMixin.md) -* [ProvsK3sBuild](doc/ProvsK3sBuild.md) -* [C4kBuild](doc/C4kBuild.md) +An example project which is using dda-devops-build can be found at: https://repo.prod.meissa.de/meissa/buildtest ## Example Build @@ -190,6 +181,19 @@ pyb [patch|minor|major] pip3 install --upgrade ddadevops ``` +## Reference + +* [DevopsBuild](./doc/DevopsBuild.md) +* [DevopsImageBuild](./doc/DevopsImageBuild.md) +* [DevopsTerraformBuild](./doc/DevopsTerraformBuild.md) + * [AwsProvider](doc/DevopsTerraformBuildWithAwsProvider.md) + * [DigitaloceanProvider](doc/DevopsTerraformBuildWithDigitaloceanProvider.md) + * [HetznerProvider](doc/DevopsTerraformBuildWithHetznerProvider.md) +* [ReleaseMixin](./doc/ReleaseMixin.md) +* [ProvsK3sBuild](doc/ProvsK3sBuild.md) +* [C4kBuild](doc/C4kBuild.md) + + ## Development & mirrors Development happens at: https://repo.prod.meissa.de/meissa/dda-devops-build From f4d30706b72842648ebf8d3f35319761218a6c90 Mon Sep 17 00:00:00 2001 From: ansgarz Date: Fri, 2 Feb 2024 10:06:05 +0100 Subject: [PATCH 3/4] fix typo --- doc/ReleaseMixin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ReleaseMixin.md b/doc/ReleaseMixin.md index 5d58f07..50a9122 100644 --- a/doc/ReleaseMixin.md +++ b/doc/ReleaseMixin.md @@ -41,7 +41,7 @@ classDiagram ### build.py ```python -rom os import environ +from os import environ from pybuilder.core import task, init from ddadevops import * From b8f7b72a619286782dcd913a7ae707d9cd396cc9 Mon Sep 17 00:00:00 2001 From: ansgarz Date: Fri, 2 Feb 2024 10:08:21 +0100 Subject: [PATCH 4/4] chg README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a677461..19ac877 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,10 @@ Principles we follow are: * Seperate build artefacts from version controlled code * Domain Driven Design - in order to stay sustainable +## Example Project + +An example project which is using dda-devops-build can be found at: https://repo.prod.meissa.de/meissa/buildtest + ## Installation Ensure that yout python3 version is at least Python 3.10