meissa/dda-devops-build
6
1
Fork 0
Code Issues Pull requests Projects Releases 33 Packages Wiki Activity

update docs

Browse source
This commit is contained in:
ansgarz 2024-01-12 11:34:38 +01:00
parent 0dcb375e15
commit fde5061bf3
2 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/CredentialsMappin.md
View file

@ -35,7 +35,12 @@ classDiagram
| name | name in context of build & ENV | - | | | name | name in context of build & ENV | - | |
## Example Usage ## 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 ```python
from os import environ from os import environ

4
doc/ReleaseMixin.md
View file

@ -26,9 +26,9 @@ classDiagram
## Input ## Input
| name | description | default | | name | description | default |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------- | | ----------------------------- |-----------------------------------------------------------------------------------------------------------------------| --------------- |
| release_type | one of MAJOR, MINOR, PATCH, NONE | "NONE" | | 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_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_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 | | | release_artifact_server_url | Optional: The base url of your forgejo/gitea instance to publish a release tode | |