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 | |