paul/gilde-ci-cd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(typos): Fix ein paar Typos

Browse Source
This commit is contained in:
Timo Beller 2022-07-19 09:54:18 +02:00
parent 15d8ad7fd8
commit ff77a88168
9 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/chapters/pipelines/eXXcellent-release.adoc
View File

@ -16,11 +16,11 @@ The main-pipeline provides infrastructure to create Gitlab-releases and the trig
The child pipeline is meant to create a new git tag with an increased Version.
When executed on it also creates a new Release Branch.
You can easily extend the child pipeline to publish Artefacts.
Although this is possible we recommend using tagged pipelines to publish Artefacts.
You can easily extend the child pipeline to publish artifacts.
Although this is possible we recommend using tagged pipelines to publish artifacts.
Tagged pipelines have the benefit that your pipelines are linked to a tag.
This makes publishing out of order or hotfixes simpler.
Since you do not relly on prior CI artefacts.
Since you do not relly on prior CI artifacts.
== Overview diagram

14
documentation/chapters/templates/container/container-build.adoc
View File

@ -4,15 +4,15 @@
.Provided Templates:
|===
|Name |Description
| .container-build-jib-maven | Baut Container mit dem Jib Plugin für Maven
| .container-build-jib-gradle | Baut Container mit dem Jib Plugin für Gradle
| .container-build-kaniko | Baut Container mit dem Kaniko
| .container-build-jib-maven | Builds the container with the Jib plugin for maven
| .container-build-jib-gradle | Builds the container with the Jib plugin for gradle
| .container-build-kaniko | Builds the container with Kaniko
|===
Allows the simple building of Container Images.
We use Kaniko because it is faster than Docker builds and has less security problems.
The generated image will be passed as a Tar-Artefact between stages.
This allows us to make forder manipulations and scan jobs on one container Image.
The generated image will be passed as a tar-artifact between stages.
This allows us to make further manipulations and scan jobs on the container image.
The template <<_container_publish>> allows you to publish the build image to a registry.
@ -21,7 +21,7 @@ The template <<_container_publish>> allows you to publish the build image to a r
|Name |Description | Default Value
|CONTEXT_LOCATION
| Defines the context of the container build. In case of jib this Path should point to the location of your Gradle/Maven projects.
| Defines the context of the container build. In case of jib, this path should point to the location of your Gradle/Maven projects.
| $CI_PROJECT_DIR
| EXTRA_ARGS
@ -35,7 +35,7 @@ The template <<_container_publish>> allows you to publish the build image to a r
| $CI_PROJECT_DIR/Dockerfile
| REGISTRY_MIRROR
| Define the container Mirror that should be used
| Define the container mirror that should be used
| exxcellent Nexus
|===

2
documentation/chapters/templates/java/gradle/gradle-build-template.adoc
View File

@ -3,7 +3,7 @@
This template resolves the gradle dependencies of your project and builds the project.
The result will be cached when you include the common CI variables.
The resulting build files will be published as artefacts.
The resulting build files will be published as artifacts.
.Variables
|===

2
documentation/chapters/templates/java/gradle/gradle-db-diff-template.adoc
View File

@ -15,7 +15,7 @@ Use the alias field in the service definition to define the address for the for
|===
|Name |Description | Default Value
|GRADLE_CLI_OPTS | Additional options send to gradle | ""
| PATH_TO_DIFF | Path to the resulting diff is defined in gradle config, this will also be exposed as the artefact of the Job. | "build/db-diff.xml"
| PATH_TO_DIFF | Path to the resulting diff is defined in gradle config, this will also be exposed as the artifact of the Job. | "build/db-diff.xml"
|===
:template: java/gradle/gradle-database-diff.gitlab-ci.yml

4
documentation/chapters/templates/java/gradle/gradle-test-template.adoc
View File

@ -4,9 +4,9 @@ endif::[]
= Gradle Database Diff
These templates starts `gradle test` and saves the results as Artifacts.
These templates starts `gradle test` and saves the results as artifacts.
When Junit Reports are generated they will be published as Artefacts within the Pipelines.
When Junit Reports are generated they will be published as artifacts within the Pipelines.
You can get a detailed view when clicking on Tests.
For more information look into the official https://docs.gitlab.com/ee/ci/unit_test_reports.html[Documentation].

2
documentation/chapters/templates/java/maven/maven-db-diff-template.adoc
View File

@ -9,7 +9,7 @@ Please look at the resulting changelog since it can have errors.
|Name |Description | Default Value
| PATH_TO_DIFF
| Path to the resulting diff is defined in gradle config, this will also be exposed as the artefact of the Job.
| Path to the resulting diff is defined in gradle config, this will also be exposed as the artifact of the Job.
| "target/db-diff.xml"
|MAVEN_CLI_OPTS | Additional Options that will be passed to Maven | ""

4
documentation/chapters/templates/java/maven/maven-verify-template.adoc
View File

@ -4,9 +4,9 @@ endif::[]
= Maven verify template
This templates starts `mvn verify` and saves the results as Artifacts.
This templates starts `mvn verify` and saves the results as artifacts.
When Junit Reports are generated they will be published as Artefacts within the Pipelines.
When Junit Reports are generated they will be published as artifacts within the Pipelines.
You can get a detailed view when clicking on Tests.
For more information look into the official https://docs.gitlab.com/ee/ci/unit_test_reports.html[Documentation].

20
documentation/document.adoc
View File

@ -52,18 +52,18 @@ include::chapters/templates/IaC/ssh-transfer-data.adoc[leveloffset=2]
== Container Templates
We have optimised building container within our templates a lot.
We found divide building and releasing containers into different jobs to be the fastest way to build container artefacts.
We found divide building and releasing containers into different jobs to be the fastest way to build container artifacts.
Because you can build your container while executing other verify stages.
Publishing containers is a very cheap operation.
The following graph charts shows thru which stages containers will go and which artefakts will be passed between stages.
The following graph charts shows through which stages containers will go and which artifacts will be passed between stages.
[mermaid]
....
flowchart LR
subgraph Build Stage
build_src(Source Code Build) -- Needs Source artefacts --> build_c
build_src(Source Code Build) -- Needs Source artifacts --> build_c
build_c(Container-Build)
end
@ -84,9 +84,9 @@ include::chapters/templates/container/docker-in-docker.adoc[leveloffset=2]
== Releasing Templates
The following Templates provide an simpler integration into the https://gitlab.exxcellent.de/gilden/ci/exxcellent-increase-version-tool[Increase-Version-Tool] of the CI-Gilde.
We also provide finished Pipelines in our <<_pipelines>> section.
We highly recommend using those Pipelines since this is our reference Implementation.
The following templates provide a simpler integration into the https://gitlab.exxcellent.de/gilden/ci/exxcellent-increase-version-tool[Increase-Version-Tool] of the CI-Gilde.
We also provide finished pipelines in our <<_pipelines>> section.
We highly recommend using those pipelines since this is our reference implementation.
include::chapters/templates/releasing/push-tag-and-version-template.adoc[leveloffset=3]
include::chapters/templates/releasing/set-version-template.adoc[leveloffset=3]
@ -115,7 +115,7 @@ include::chapters/templates/java/maven/maven-db-diff-template.adoc[leveloffset=2
== Gradle Templates
Our collection of Gradle Templates.
Currently, we start our Templates from the Gradle Wrapper within your Projekt.
Currently, we start our templates from the gradle wrapper within your project.
If you do not have a wrapper you can create on with the command `gradle wrapper`.
Please keep in mind updating the wrapper from time to time.
We recommend using https://www.exxcellent.de/confluence/x/S4WCC[Renovate] for this task.
@ -126,7 +126,7 @@ include::chapters/templates/java/gradle/gradle-db-diff-template.adoc[leveloffset
== Static Analysis
With the following collection we provide Static code and Artefact analysis tools.
With the following collection we provide static code and artifact analysis tools.
include::chapters/templates/static-analysis/repo-cve-scan.adoc[leveloffset=2]
include::chapters/templates/static-analysis/sonar-7.adoc[leveloffset=2]
@ -134,13 +134,13 @@ include::chapters/templates/static-analysis/sonar-8.adoc[leveloffset=2]
== Documentation
This collection provides templates to simplify your dokumentation prozess.
This collection provides templates to simplify your documentation process.
include::chapters/templates/documentation/documentation.adoc[leveloffset=2]
== Licensing
This collection provides templates to simplify your licencing prozess.
This collection provides templates to simplify your licencing process.
include::chapters/templates/license/license.gitlab-ci.adoc[leveloffset=2]
include::chapters/templates/java/gradle/gradle-license.gitlab-ci.adoc[leveloffset=2]

6
documentation/generalInformation.adoc
View File

@ -19,8 +19,8 @@ flowchart LR
Jobs within this stage are loading all needed Dependencies. This is done for better cache management of Dependencies.
=== Build - build
Jobs within this stage, build all needed artefacts that you need in later stages and for releasing.
In case you need to build multiple artefacts execute following jobs as soon as needed artefacts are build.
Jobs within this stage, build all needed artifacts that you need in later stages and for releasing.
In case you need to build multiple artifacts execute following jobs as soon as needed artifacts are build.
Look into Gitlabs https://docs.gitlab.com/ee/ci/yaml/#needs[Needs Documentation].
=== Verify - verify
@ -32,7 +32,7 @@ Verify and Test as much as you can in these Jobs.
Jobs within this stage build and publish your documentation.
=== Release - release
Jobs within this stage publish your artefacts or automate creating Tags.
Jobs within this stage publish your artifacts or automate creating Tags.
For more information look into <<_pipeline_release>>
== About Templates and Pipelines