From 408e4eab9e1f61004f1e38af6d1531747b7da99b Mon Sep 17 00:00:00 2001 From: Jon Date: Sat, 13 May 2023 15:35:28 +0930 Subject: [PATCH] refactor: move docs as part of restructure !21 --- .../projects/gitlab-ci/ansible_roles.md | 9 +++++- .../gitlab-ci/conventional_commits.md | 28 +++++++++++------- pages/projects/gitlab-ci/docker_container.md | 29 +++++++++++++++++++ .../projects/gitlab-ci/git_mirror.md | 9 +++++- .../projects/gitlab-ci/gitlab_release.md | 11 ++++++- .../projects/gitlab-ci/python.md | 10 ++++++- .../projects/gitlab-ci/yaml_lint.md | 9 +++++- 7 files changed, 90 insertions(+), 15 deletions(-) rename ansible/README.md => pages/projects/gitlab-ci/ansible_roles.md (87%) rename conventional_commits/README.md => pages/projects/gitlab-ci/conventional_commits.md (87%) create mode 100644 pages/projects/gitlab-ci/docker_container.md rename git_push_mirror/README.md => pages/projects/gitlab-ci/git_mirror.md (88%) rename gitlab_release/README.md => pages/projects/gitlab-ci/gitlab_release.md (94%) rename python/README.md => pages/projects/gitlab-ci/python.md (93%) rename yaml_lint/README.md => pages/projects/gitlab-ci/yaml_lint.md (87%) diff --git a/ansible/README.md b/pages/projects/gitlab-ci/ansible_roles.md similarity index 87% rename from ansible/README.md rename to pages/projects/gitlab-ci/ansible_roles.md index cc4e26c..861d98e 100644 --- a/ansible/README.md +++ b/pages/projects/gitlab-ci/ansible_roles.md @@ -1,4 +1,11 @@ -# Ansible +--- +title: Ansible +description: How to use No Fuss Computings gitlab-ci job for ansible +date: 2021-08-03 +template: manual.html +about: https://gitlab.com/nofusscomputing/projects/gitlab-ci +--- + This job does ansible role/playbook linting when any commit is pushed to any branch. diff --git a/conventional_commits/README.md b/pages/projects/gitlab-ci/conventional_commits.md similarity index 87% rename from conventional_commits/README.md rename to pages/projects/gitlab-ci/conventional_commits.md index cfc2045..3f99ca6 100644 --- a/conventional_commits/README.md +++ b/pages/projects/gitlab-ci/conventional_commits.md @@ -1,4 +1,12 @@ -# Conventional Commits User Manual +--- +title: Conventional Commits +description: How to use No Fuss Computings gitlab-ci job for Conventional Commits +date: 2021-08-03 +template: manual.html +about: https://gitlab.com/nofusscomputing/projects/gitlab-ci +--- + +## User Manual Commitizen is used to validate the format of commit messages. we use [Conventional Commit Messages](https://www.conventionalcommits.org/en/v1.0.0/) format for our validation jobs. This repository may have two CI jobs to do with commitizen: @@ -9,17 +17,17 @@ These CI Jobs output a test report that can be viewed inside of the merge reques To fix an error please refer to the titled sections below. -## MR Title +### MR Title Ensure that the merge request title is in the [conventional message](https://www.conventionalcommits.org/en/v1.0.0/) format. NOTE: the title is case sensitive. -## Commit Messages +### Commit Messages All commit messages that form part of your merge request must be in [conventional message](https://www.conventionalcommits.org/en/v1.0.0/) format. To fix them go back and edit your commit messages. -### fixing commit messages (suggestion) +#### fixing commit messages (suggestion) If only the last commit is the commit with an error just use `git commit --amend` and edit your commit message to be in the correct format and save. now push your changes. @@ -51,18 +59,18 @@ Now push your changes upstream. | *Ensure that all of your commits were exported prior to reseting the branch and when re-applying, that all of your commits were applied correctly* | -# Conventional Commits Admin Manual Manual +## Conventional Commits Admin Manual Manual This job checks commit messages on a branch and the merge request title for validity against the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) This job provides the following badge: - None -## Dependencies +### Dependencies - None -## your .gitlab-ci.yml changes +### your .gitlab-ci.yml changes To use this job add the following to your `.gitlab-ci.yml` file ``` yaml @@ -84,11 +92,11 @@ include: | MR_ACCESS_TOKEN | *only required if you are accessing a private repository.*
This token is a user access token that as a minimum requires read-only access to the api to fetch the projects merg requests. | -## Job Workflow +### Job Workflow -## Artifacts +### Artifacts -## License +### License To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) diff --git a/pages/projects/gitlab-ci/docker_container.md b/pages/projects/gitlab-ci/docker_container.md new file mode 100644 index 0000000..2af5db4 --- /dev/null +++ b/pages/projects/gitlab-ci/docker_container.md @@ -0,0 +1,29 @@ +--- +title: Docker Container CI Template +description: How to use No Fuss Computings gitlab-ci template for docker containers +date: 2023-05-13 +template: manual.html +about: https://gitlab.com/nofusscomputing/projects/gitlab-ci +--- + +- available tags `dev` for latest dev build +- latest matches latest git tag + + +- notate available platforms can be viewed in the job + +``` yaml + # Available platforms: linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/arm64, linux/riscv64, linux/ppc64, linux/ppc64le, linux/s390x, linux/386, linux/mips64le, linux/mips64, linux/arm/v7, linux/arm/v6 + # DOCKER_IMAGE_BUILD_TARGET_PLATFORMS: "linux/amd64,linux/arm64,linux/arm/v7" + DOCKER_IMAGE_BUILD_NAME: $CI_PROJECT_NAME + DOCKER_IMAGE_BUILD_REGISTRY: $CI_REGISTRY_IMAGE + DOCKER_IMAGE_BUILD_TAG: $CI_COMMIT_SHA + + # DOCKER_IMAGE_PUBLISH_NAME: $CI_PROJECT_NAME + # DOCKER_IMAGE_PUBLISH_REGISTRY: docker.io/nofusscomputing + # DOCKER_IMAGE_PUBLISH_URL: https://hub.docker.com/r/nofusscomputing/$DOCKER_IMAGE_PUBLISH_NAME + # JOB_STOP_CONVENTIONAL_COMMITS: 'any_value' + # JOB_STOP_GIT_PUSH_MIRROR: 'any_value' + # GIT_SYNC_URL: "https://$GITHUB_USERNAME_ROBOT:$GITHUB_TOKEN_ROBOT@github.com/NoFussComputing/config.git" # Must be defined for job to run + # JOB_STOP_GITLAB_RELEASE: 'any value' +``` \ No newline at end of file diff --git a/git_push_mirror/README.md b/pages/projects/gitlab-ci/git_mirror.md similarity index 88% rename from git_push_mirror/README.md rename to pages/projects/gitlab-ci/git_mirror.md index 7af226c..1661600 100644 --- a/git_push_mirror/README.md +++ b/pages/projects/gitlab-ci/git_mirror.md @@ -1,4 +1,11 @@ -# git push mirror Admin Manual Manual +--- +title: Git push mirror +description: How to use No Fuss Computings gitlab-ci job for repository mirrororing +date: 2021-08-03 +template: manual.html +about: https://gitlab.com/nofusscomputing/projects/gitlab-ci +--- + This job does a git push to a remote git repo. diff --git a/gitlab_release/README.md b/pages/projects/gitlab-ci/gitlab_release.md similarity index 94% rename from gitlab_release/README.md rename to pages/projects/gitlab-ci/gitlab_release.md index c1d90e8..40c1484 100644 --- a/gitlab_release/README.md +++ b/pages/projects/gitlab-ci/gitlab_release.md @@ -1,4 +1,13 @@ -# Commit Message Footer References - User Manual +--- +title: Gitlab Release / Commit Footer References +description: How to use No Fuss Computings gitlab-ci job for Gitlab Releases and commit footer messages +date: 2021-08-03 +template: manual.html +about: https://gitlab.com/nofusscomputing/projects/gitlab-ci +--- + + +# User Manual All commit messages must be in [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) and have a footer with a gitlab reference. The reference **must** be either a merge request or a gitlab issue. (format i.e. `!1` or `#2` *using the correct reference number*). diff --git a/python/README.md b/pages/projects/gitlab-ci/python.md similarity index 93% rename from python/README.md rename to pages/projects/gitlab-ci/python.md index 17e4d89..e09a4e9 100644 --- a/python/README.md +++ b/pages/projects/gitlab-ci/python.md @@ -1,4 +1,12 @@ -# Python +--- +title: Python +description: How to use No Fuss Computings gitlab-ci job for Python +date: 2021-08-11 +template: manual.html +about: https://gitlab.com/nofusscomputing/projects/gitlab-ci +--- + + This folder (`python`) covers jobs for python development diff --git a/yaml_lint/README.md b/pages/projects/gitlab-ci/yaml_lint.md similarity index 87% rename from yaml_lint/README.md rename to pages/projects/gitlab-ci/yaml_lint.md index 03fddc6..427f6b9 100644 --- a/yaml_lint/README.md +++ b/pages/projects/gitlab-ci/yaml_lint.md @@ -1,4 +1,11 @@ -# Yaml Lint +--- +title: YAML Linting +description: How to use No Fuss Computings gitlab-ci job for YAML Linting +date: 2021-08-11 +template: manual.html +about: https://gitlab.com/nofusscomputing/projects/gitlab-ci +--- + This job does yaml linting when any commit is pushed to any branch.