From 67b18318ca28c6dc554ceae6560f7f55fdf7c9d5 Mon Sep 17 00:00:00 2001
From: ansgarz <ansgar.zwick@meissa.de>
Date: Fri, 26 Jan 2024 10:29:26 +0100
Subject: [PATCH] add comments to build.py

---
 build.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/build.py b/build.py
index c8367b2..3c4c15f 100644
--- a/build.py
+++ b/build.py
@@ -8,6 +8,7 @@ PROJECT_ROOT_PATH = "."
 
 version = "1.8.5-dev"
 
+
 @init
 def initialize(project):
     input = {
@@ -33,18 +34,30 @@ def initialize(project):
 
 @task
 def patch(project):
+    """
+    updates version to next patch level, creates a tag, creates new SNAPSHOT version,
+    commits primary build file (build.gradle) and pushes to remote
+    """
     linttest(project, "PATCH")
     release(project)
 
 
 @task
 def minor(project):
+    """
+    updates version to next minor level, creates a tag, creates new SNAPSHOT version,
+    commits primary build file (build.gradle) and pushes to remote
+    """
     linttest(project, "MINOR")
     release(project)
 
 
 @task
 def major(project):
+    """
+    updates version to next major level, creates a tag, creates new SNAPSHOT version,
+    commits primary build file (build.gradle) and pushes to remote
+    """
     linttest(project, "MAJOR")
     release(project)
 
@@ -68,6 +81,7 @@ def tag(project):
 
 @task
 def publish_artifacts(project):
+    """ creates a release in <release_artifact_server_url> and uploads artifacts """
     build = get_devops_build(project)
     print("PROTECTED_TOKEN_EXAMPLE" in environ)
     print(environ.get("PROTECTED_TOKEN_EXAMPLE"))