infrastructure/gitlab-ci
2
0
Fork 0
Code Issues 17 Pull Requests 1 Actions Projects Releases 21 Wiki Activity

docs: notate under development

Browse Source 
!25
This commit is contained in:
Jon Lockwood
2023-05-22 14:43:41 +09:30
parent 61200e526e
commit b66abc1947
13 changed files with 39 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
mkdocs.yml
View File

@ -11,14 +11,10 @@ nav:
- articles/index.md - articles/index.md
- Content Tags: tags.md
- Projects: - Projects:
- projects/index.md - projects/index.md
#- Ansible Roles: projects/ansible-roles/index.md
- Gitlab CI: - Gitlab CI:
- Build: - Build:

6
pages/projects/gitlab-ci/conventional_commits.md
View File

@ -119,7 +119,5 @@ In addition to the required variables above, the commitizen config file `.cz.yam
### Artifacts ### Artifacts
!!! Note
### License Docs Still under development
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)

6
pages/projects/gitlab-ci/git_mirror.md
View File

@ -73,7 +73,5 @@ This will cause the job to only run on the `development` branch.
- None - None
!!! Note
## License Docs Still under development
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)

7
pages/projects/gitlab-ci/gitlab_release.md
View File

@ -140,8 +140,5 @@ This CI job's workflow is:
- `Gitlab Release` - `Gitlab Release`
> None > None
!!! Note
### License Docs Still under development
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)

8
pages/projects/gitlab-ci/index.md
View File

@ -5,3 +5,11 @@ date: 2021-08-11
template: project.html template: project.html
about: https://gitlab.com/nofusscomputing/projects/gitlab-ci about: https://gitlab.com/nofusscomputing/projects/gitlab-ci
--- ---
!!! Note
Docs Still under development
## Docs ToDo
- Templates folder is for `gitlab-ci.yaml` that automagically create the jobs if included
- other sub folders are for `` which **DO NOT** automagically create jobs, but are pure definitions only.

6
pages/projects/gitlab-ci/markdown_lint.md
View File

@ -59,7 +59,5 @@ Markdown Linting:
- JUnit test report located at `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/*.junit.xml` - JUnit test report located at `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/*.junit.xml`
!!! Note
## License Docs Still under development
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)

6
pages/projects/gitlab-ci/mkdocs-build.md
View File

@ -66,7 +66,5 @@ MKDocs build:
- files in `"$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"` - files in `"$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"`
!!! Note
## License Docs Still under development
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)

6
pages/projects/gitlab-ci/python.md
View File

@ -105,7 +105,5 @@ PyLint:
- `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html` - html code quality report - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html` - html code quality report
!!! Note
## License Docs Still under development
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)

5
pages/projects/gitlab-ci/templates/ansible_roles.md
View File

@ -62,8 +62,3 @@ Ansible Lint (python 3.6):
- `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/$PYTHON_VERSION-ansible-lint.junit.xml` - JUnit Test report - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/$PYTHON_VERSION-ansible-lint.junit.xml` - JUnit Test report
- `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-ansible-lint.log` - Linter log - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-ansible-lint.log` - Linter log
## License
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)

3
pages/projects/gitlab-ci/templates/docker_container.md
View File

@ -30,3 +30,6 @@ about: https://gitlab.com/nofusscomputing/projects/gitlab-ci
# JOB_STOP_GITLAB_RELEASE: 'any value' # JOB_STOP_GITLAB_RELEASE: 'any value'
``` ```
!!! Note
Docs Still under development

11
pages/projects/gitlab-ci/templates/index.md
View File

@ -6,4 +6,13 @@ template: project.html
about: https://gitlab.com/nofusscomputing/projects/gitlab-ci about: https://gitlab.com/nofusscomputing/projects/gitlab-ci
--- ---
As part of our Gitlab CI job definitions we also have gitlab-ci.yaml templates that are specifically designed for inclusion and will automagically add the required jobs. As part of our Gitlab CI job definitions we also have gitlab-ci.yaml templates that are specifically designed for inclusion and will automagically add the required jobs.
## Docs ToDo
- all templates are in the template folder.
- explain `.gitlab-ci_common.yaml` is for inclusion by all, _suggested._ and will never create jobs, only specify defaults. is also included in all templates
!!! Note
Docs Still under development

5
pages/projects/gitlab-ci/templates/website.md
View File

@ -9,4 +9,7 @@ about: https://gitlab.com/nofusscomputing/projects/gitlab-ci
This template creates the jobs applicable to publishing pages to a website. The website in question is a static site built by MKDocs. This template creates the jobs applicable to publishing pages to a website. The website in question is a static site built by MKDocs.
!!! Note !!! Note
This template is specifically designed for deployment to https://nofusscomputing.com. However you _may_ be able to override the job definition to use it for your website. This template is specifically designed for deployment to https://nofusscomputing.com. However you _may_ be able to override the job definition to use it for your website.
!!! Note
Docs Still under development

5
pages/projects/gitlab-ci/yaml_lint.md
View File

@ -65,6 +65,5 @@ Yaml Lint (python 3.6):
- `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-yaml-lint.log` - Linter log - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-yaml-lint.log` - Linter log
## License !!! Note
Docs Still under development
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)