From 28c04fb2e854521167367161d13b09650829d17d Mon Sep 17 00:00:00 2001 From: Jon Date: Tue, 23 May 2023 09:54:53 +0930 Subject: [PATCH] docs: add job definitions to page !26 --- docs/projects/gitlab-ci/conventional_commits.md | 11 +++++++++++ docs/projects/gitlab-ci/git_mirror.md | 11 +++++++++++ docs/projects/gitlab-ci/gitlab_release.md | 11 +++++++++++ docs/projects/gitlab-ci/markdown_lint.md | 11 +++++++++++ docs/projects/gitlab-ci/python.md | 11 +++++++++++ docs/projects/gitlab-ci/yaml_lint.md | 10 ++++++++++ 6 files changed, 65 insertions(+) diff --git a/docs/projects/gitlab-ci/conventional_commits.md b/docs/projects/gitlab-ci/conventional_commits.md index 04c61da..99db485 100644 --- a/docs/projects/gitlab-ci/conventional_commits.md +++ b/docs/projects/gitlab-ci/conventional_commits.md @@ -119,5 +119,16 @@ In addition to the required variables above, the commitizen config file `.cz.yam ### Artifacts + +## Gitlab job Definition + +When you include this definition the following makes up the job definition + +``` yaml title=".gitlab-ci.yml" linenums="1" + +--8<-- "conventional_commits/.gitlab-ci.yml" + +``` + !!! Note Docs Still under development diff --git a/docs/projects/gitlab-ci/git_mirror.md b/docs/projects/gitlab-ci/git_mirror.md index c65eb0a..7c21c65 100644 --- a/docs/projects/gitlab-ci/git_mirror.md +++ b/docs/projects/gitlab-ci/git_mirror.md @@ -73,5 +73,16 @@ This will cause the job to only run on the `development` branch. - None + +## Gitlab job Definition + +When you include this definition the following makes up the job definition + +``` yaml title=".gitlab-ci.yml" linenums="1" + +--8<-- "git_push_mirror/.gitlab-ci.yml" + +``` + !!! Note Docs Still under development diff --git a/docs/projects/gitlab-ci/gitlab_release.md b/docs/projects/gitlab-ci/gitlab_release.md index d28dcf8..8deec0f 100644 --- a/docs/projects/gitlab-ci/gitlab_release.md +++ b/docs/projects/gitlab-ci/gitlab_release.md @@ -140,5 +140,16 @@ This CI job's workflow is: - `Gitlab Release` > None + +## Gitlab job Definition + +When you include this definition the following makes up the job definition + +``` yaml title=".gitlab-ci.yml" linenums="1" + +--8<-- "gitlab_release/.gitlab-ci.yml" + +``` + !!! Note Docs Still under development diff --git a/docs/projects/gitlab-ci/markdown_lint.md b/docs/projects/gitlab-ci/markdown_lint.md index 29c208f..71c49ef 100644 --- a/docs/projects/gitlab-ci/markdown_lint.md +++ b/docs/projects/gitlab-ci/markdown_lint.md @@ -59,5 +59,16 @@ Markdown Linting: - JUnit test report located at `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/*.junit.xml` + +## Gitlab job Definition + +When you include this definition the following makes up the job definition + +``` yaml title=".gitlab-ci.yml" linenums="1" + +--8<-- "lint/markdown.gitlab-ci.yaml" + +``` + !!! Note Docs Still under development diff --git a/docs/projects/gitlab-ci/python.md b/docs/projects/gitlab-ci/python.md index 05e2d04..6484c21 100644 --- a/docs/projects/gitlab-ci/python.md +++ b/docs/projects/gitlab-ci/python.md @@ -105,5 +105,16 @@ PyLint: - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html` - html code quality report + +## Gitlab job Definition + +When you include this definition the following makes up the job definition + +``` yaml title=".gitlab-ci.yml" linenums="1" + +--8<-- "python/.gitlab-ci.yml" + +``` + !!! Note Docs Still under development diff --git a/docs/projects/gitlab-ci/yaml_lint.md b/docs/projects/gitlab-ci/yaml_lint.md index 63d1b51..c4ca22a 100644 --- a/docs/projects/gitlab-ci/yaml_lint.md +++ b/docs/projects/gitlab-ci/yaml_lint.md @@ -65,5 +65,15 @@ Yaml Lint (python 3.6): - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-yaml-lint.log` - Linter log +## Gitlab job Definition + +When you include this definition the following makes up the job definition + +``` yaml title=".gitlab-ci.yml" linenums="1" + +--8<-- "lint/yaml.gitlab-ci.yaml" + +``` + !!! Note Docs Still under development