re-generated documentation output

ThomasSteinbach · ThomasSteinbach · commit cdd6fda57c93 · 2021-03-12T22:26:38.000+01:00
diff --git a/docs/api/gcip/addons/kaniko/jobs.html b/docs/api/gcip/addons/kaniko/jobs.html
@@ -40,7 +40,7 @@ <h1 class="title">Module <code>gcip.addons.kaniko.jobs</code></h1>
 
 
 def execute(
-    gitlab_executor_image: Optional[Union[Image, str]] = Image(&#34;gcr.io/kaniko-project/executor:latest&#34;, entrypoint=[&#34;&#34;]),
+    gitlab_executor_image: Optional[Union[Image, str]] = Image(&#34;gcr.io/kaniko-project/executor:debug&#34;, entrypoint=[&#34;&#34;]),
     context: Optional[str] = None,
     image_name: Optional[str] = None,
     image_tag: Optional[str] = None,
@@ -116,6 +116,9 @@ <h1 class="title">Module <code>gcip.addons.kaniko.jobs</code></h1>
 
     executor_cmd: List[str] = [&#34;executor&#34;]
 
+    if not context and PredefinedVariables.CI_PROJECT_DIR:
+        context = PredefinedVariables.CI_PROJECT_DIR
+
     if context:
         if context.endswith(&#34;/&#34;):
             context = context[:-1]
@@ -130,6 +133,9 @@ <h1 class="title">Module <code>gcip.addons.kaniko.jobs</code></h1>
     if verbosity:
         executor_cmd.append(f&#34;--verbosity {verbosity}&#34;)
 
+    if not dockerfile and PredefinedVariables.CI_PROJECT_DIR:
+        dockerfile = f&#34;{PredefinedVariables.CI_PROJECT_DIR}/Dockerfile&#34;
+
     if dockerfile:
         executor_cmd.append(f&#34;--dockerfile {dockerfile}&#34;)
 
@@ -163,11 +169,9 @@ <h1 class="title">Module <code>gcip.addons.kaniko.jobs</code></h1>
         job.prepend_scripts(&#39;mkdir -p /kaniko/.docker &amp;&amp; echo &#34;{\\&#34;credsStore\\&#34;:\\&#34;ecr-login\\&#34;}&#34; &gt; /kaniko/.docker/config.json&#39;)
 
     if dockerhub_user_env_var and dockerhub_login_env_var:
-        # auth=$(echo &#34;$DOCKER_USER:$DOCKER_LOGIN&#34; | base64)
-        auth = f&#39;$(echo &#34;${dockerhub_user_env_var}:${dockerhub_login_env_var}&#34; | base64)&#39;
         job.prepend_scripts(
-            &#39;mkdir -p /kaniko/.docker &amp;&amp; echo &#34;{\\&#34;auths\\&#34;:{\\&#34;https://index.docker.io/v1/\\&#34;:{\\&#34;auth\\&#34;:\\&#34;&#39; + auth +
-            &#39;\\&#34;}}}&#34; &gt; /kaniko/.docker/config.json&#39;
+            &#39;mkdir -p /kaniko/.docker &amp;&amp; echo &#34;{\\&#34;auths\\&#34;:{\\&#34;https://index.docker.io/v1/\\&#34;:{\\&#34;username\\&#34;:\\&#34;$&#39; +
+            dockerhub_user_env_var + &#39;\\&#34;,\\&#34;password\\&#34;:\\&#34;$&#39; + dockerhub_login_env_var + &#39;\\&#34;}}}&#34; &gt; /kaniko/.docker/config.json&#39;
         )
 
     job.append_scripts(&#34; &#34;.join(executor_cmd), &#34;rm -rf /kaniko/.docker/config.json&#34;)
@@ -249,7 +253,7 @@ <h2 id="returns">Returns</h2>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def execute(
-    gitlab_executor_image: Optional[Union[Image, str]] = Image(&#34;gcr.io/kaniko-project/executor:latest&#34;, entrypoint=[&#34;&#34;]),
+    gitlab_executor_image: Optional[Union[Image, str]] = Image(&#34;gcr.io/kaniko-project/executor:debug&#34;, entrypoint=[&#34;&#34;]),
     context: Optional[str] = None,
     image_name: Optional[str] = None,
     image_tag: Optional[str] = None,
@@ -325,6 +329,9 @@ <h2 id="returns">Returns</h2>
 
     executor_cmd: List[str] = [&#34;executor&#34;]
 
+    if not context and PredefinedVariables.CI_PROJECT_DIR:
+        context = PredefinedVariables.CI_PROJECT_DIR
+
     if context:
         if context.endswith(&#34;/&#34;):
             context = context[:-1]
@@ -339,6 +346,9 @@ <h2 id="returns">Returns</h2>
     if verbosity:
         executor_cmd.append(f&#34;--verbosity {verbosity}&#34;)
 
+    if not dockerfile and PredefinedVariables.CI_PROJECT_DIR:
+        dockerfile = f&#34;{PredefinedVariables.CI_PROJECT_DIR}/Dockerfile&#34;
+
     if dockerfile:
         executor_cmd.append(f&#34;--dockerfile {dockerfile}&#34;)
 
@@ -372,11 +382,9 @@ <h2 id="returns">Returns</h2>
         job.prepend_scripts(&#39;mkdir -p /kaniko/.docker &amp;&amp; echo &#34;{\\&#34;credsStore\\&#34;:\\&#34;ecr-login\\&#34;}&#34; &gt; /kaniko/.docker/config.json&#39;)
 
     if dockerhub_user_env_var and dockerhub_login_env_var:
-        # auth=$(echo &#34;$DOCKER_USER:$DOCKER_LOGIN&#34; | base64)
-        auth = f&#39;$(echo &#34;${dockerhub_user_env_var}:${dockerhub_login_env_var}&#34; | base64)&#39;
         job.prepend_scripts(
-            &#39;mkdir -p /kaniko/.docker &amp;&amp; echo &#34;{\\&#34;auths\\&#34;:{\\&#34;https://index.docker.io/v1/\\&#34;:{\\&#34;auth\\&#34;:\\&#34;&#39; + auth +
-            &#39;\\&#34;}}}&#34; &gt; /kaniko/.docker/config.json&#39;
+            &#39;mkdir -p /kaniko/.docker &amp;&amp; echo &#34;{\\&#34;auths\\&#34;:{\\&#34;https://index.docker.io/v1/\\&#34;:{\\&#34;username\\&#34;:\\&#34;$&#39; +
+            dockerhub_user_env_var + &#39;\\&#34;,\\&#34;password\\&#34;:\\&#34;$&#39; + dockerhub_login_env_var + &#39;\\&#34;}}}&#34; &gt; /kaniko/.docker/config.json&#39;
         )
 
     job.append_scripts(&#34; &#34;.join(executor_cmd), &#34;rm -rf /kaniko/.docker/config.json&#34;)
diff --git a/docs/user/index.html b/docs/user/index.html
@@ -510,17 +510,30 @@ <h2 id="_code_documentation">Code documentation</h2>
 <h2 id="_configuring_your_project_to_use_gcip">Configuring your project to use gcip</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>Create a <code>.gitlab-ci.yaml</code> with following static content:</p>
+<p>Your Gitlab project needs these two files:</p>
+</div>
+<div class="quoteblock">
+<blockquote>
+<div class="paragraph">
+<p>MyProject
+├ .gitlab-ci.py
+└ .gitlab-ci.yml</p>
+</div>
+</blockquote>
+</div>
+<div class="paragraph">
+<p>The  <code>.gitlab-ci.yml</code> is the file you already know. It&#8217;s only task is to
+render and trigger the child Pipeline created with the Gitlab CI Python Library.
+Latter is written into the <code>.gitlab-ci.py</code>. Here is how your <code>.gitlab-ci.yml</code> should
+look like:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre>---
 generate-pipeline:
   stage: build
-  image: python:3
-  script:
-    - pip3 install -r requirements.txt
-    - python3 .gitlab-ci.py &gt; generated-config.yml
+  image: thomass/gcip:0.3.0
+  script: /usr/src/app/docker/gcip.sh
   artifacts:
     paths:
       - generated-config.yml
@@ -537,7 +550,8 @@ <h2 id="_configuring_your_project_to_use_gcip">Configuring your project to use g
 </div>
 </div>
 <div class="paragraph">
-<p>Your gcip pipeline code then goes into a file named <code>.gitlab-ci.py</code>.</p>
+<p>Your gcip pipeline code then goes into the file named <code>.gitlab-ci.py</code>. The following
+chapers show to crete the pipeline code.</p>
 </div>
 </div>
 </div>
@@ -546,7 +560,23 @@ <h2 id="_hints_regarding_the_following_examples">Hints regarding the following e
 <div class="sectionbody">
 <div class="paragraph">
 <p>All the code examples in the following chapters are made for also be run with Pytest.
-Thus to use the code for your real life Gitlab CI pipeline you have to change the following:</p>
+For instance a code example could look like following:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>import gcip
+from tests import conftest
+
+
+def test():
+    pipeline = gcip.Pipeline()
+    pipeline.add_children(gcip.Job(namespace="print_date", script="date"))
+
+    conftest.check(pipeline.render())</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>To transform this pytest into a valid <code>.gitlab-ci.py</code> file your have to:</p>
 </div>
 <div class="ulist">
 <ul>
@@ -557,11 +587,24 @@ <h2 id="_hints_regarding_the_following_examples">Hints regarding the following e
 <p>Put your pipeline code plain into the Python script and not within the <code>def test():</code> method.</p>
 </li>
 <li>
-<p>Instead of routing the pipeline output to the test method (<code>conftest.check(pipeline.render())</code>)
-print the resulting pipeline to STDOUT with <code>pipeline.print_yaml()</code>.</p>
+<p>Instead of testing rendered pipelin with <code>conftest.check(pipeline.render())</code> you have to
+write the <code>generated-pipeline.yml</code> with <code>pipeline.write_yaml()</code>.</p>
 </li>
 </ul>
 </div>
+<div class="paragraph">
+<p>The real <code>.gitlab-ci.py</code> code derived from the example would look like following:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>from tests import conftest
+
+pipeline = gcip.Pipeline()
+pipeline.add_children(gcip.Job(namespace="print_date", script="date"))
+
+pipeline.write_yaml()</pre>
+</div>
+</div>
 </div>
 </div>
 <div class="sect1">
@@ -585,7 +628,7 @@ <h2 id="_create_a_pipeline_with_one_job">Create a pipeline with one job</h2>
 </div>
 <div class="paragraph">
 <p>Remember: As stated in the <a href="#hints-regarding-the-following-examples">hints regarding the examples</a>,
-your real pipeline code must end with <code>pipeline.print_yaml()</code> instead of <code>conftest.check(pipeline.render())</code>!</p>
+your real pipeline code must end with <code>pipeline.write_yaml()</code> instead of <code>conftest.check(pipeline.render())</code>!</p>
 </div>
 <div class="paragraph">
 <p><strong>Output:</strong></p>
@@ -1689,7 +1732,7 @@ <h2 id="_licence">Licence</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2021-03-11 13:42:37 +0100
+Last updated 2021-03-12 22:24:00 +0100
 </div>
 </div>
 </body>
