Merge branch 'feat/templates-mail-and-ssh' into 'master'

feat(ssh): templates for mail and ssh transfer data tools

See merge request gilden/ci/gitlab-ci-templates!26

documentation/chapters/templates/docker-compose-deploy.adoc

@@ -60,6 +60,6 @@ Secrets sollten nicht in der Repository liegen sondern in den CI-CD variablen de
 
 .Docker compose deploy
 ----
-include::{sourcedir}/docker-compose-deploy.yml[]
+include::{sourcedir}/docker-compose-deploy.gitlab-ci.yml[]
 ----
 

documentation/chapters/templates/docker-compose-validate.adoc

@@ -15,5 +15,5 @@ Validiert die semantische Korrektheit eines Docker-Compose files.
 
 .Docker compose validate
 ----
-include::{sourcedir}/docker-compose-validate.yml[]
+include::{sourcedir}/docker-compose-validate.gitlab-ci.yml[]
 ----

documentation/chapters/templates/mail-template.adoc

@@ -0,0 +1,22 @@
+:sourcedir: ../../../
+
+= mail-template
+
+This template provides a service to send mails from a pipeline with the help of a smtp server.
+For more details: https://gitlab.exxcellent.de/gilden/ci/exxcellent-mail-tool[Gilde CI/CD: exxcellent-mail-tool].
+
+
+.Variables
+|===
+|Name |Description | Default Value
+|SMTP_PORT | the smtp port |25
+|SMTP_AUTH | flag if smtp auth should be used |off
+|===
+
+NOTE: The template uses the port 25 config as a default which doesn't need a smtp auth and a smtp user with the restriction that it only works from within the exxcellent gitlab-ci runners. For other configs visit the https://gitlab.exxcellent.de/gilden/ci/exxcellent-mail-tool[mail-tool docs]
+
+.mail-template
+[source, yaml]
+----
+include::{sourcedir}/mail-template.gitlab-ci.yml[]
+----

documentation/chapters/templates/ssh-transfer-data-template.adoc

@@ -0,0 +1,20 @@
+:sourcedir: ../../../
+
+= ssh-transfer-data-template
+
+This template provides a service to transfer data from a pipeline to a remote server.
+For more details: https://gitlab.exxcellent.de/gilden/ci/exxcellent-ssh-tool#user-content-use-case-copy-data-with-scp[Gilde CI/CD: exxcellent-ssh-tool].
+
+
+.Variables
+|===
+|Name |Description | Default Value
+|SSH_USER | the name of the remote user |-
+|SSH_HOST | the name of the remote host |-
+|===
+
+.ssh-transfer-data-template
+[source, yaml]
+----
+include::{sourcedir}/ssh-transfer-data-template.gitlab-ci.yml[]
+----

documentation/document.adoc

@@ -78,7 +78,9 @@ Sollte dieser noch nicht vorhanden sein kann er mit dem Befehl `gradle wrapper`
 include::chapters/templates/gradle-build-template.adoc[leveloffset=2]
 include::chapters/templates/gradle-test-template.adoc[leveloffset=2]
 
-== weitere Gilden-Tools
+== Weitere Gilden-Tools
 
 include::chapters/templates/tool-sonar7.adoc[leveloffset=2]
 include::chapters/templates/tool-documentation-tool.adoc[leveloffset=2]
+include::chapters/templates/mail-template.adoc[leveloffset=2]
+include::chapters/templates/ssh-transfer-data-template.adoc[leveloffset=2]

mail-template.gitlab-ci.yml

@@ -0,0 +1,8 @@
+.send-mail:
+  image: gitlab.exxcellent.de:4567/gilden/ci/exxcellent-mail-tool:1.1.0
+  stage: send-mail
+  variables:
+    SMTP_PORT: "25"
+    SMTP_AUTH: "off"
+  rules:
+    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH

ssh-transfer-data-template.gitlab-ci.yml

@@ -0,0 +1,5 @@
+.ssh-transfer-data:
+  image: gitlab.exxcellent.de:4567/gilden/ci/exxcellent-ssh-tool:1.3.0
+  stage: ssh-transfer-data
+  before_script:
+    - setup-ssh