Jon Lockwood
2c61651d9c
The badge table did not render on github, adjuested so that each row is on one line for github markdown to function !7
109 lines
5.7 KiB
Markdown
109 lines
5.7 KiB
Markdown
<div align="center">
|
|
|
|
# No Fuss Computing - Gitlab-CI
|
|
|
|
[](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues)
|
|
|
|
|
|
| Stable Branch | [](https://gitlab.com/nofusscomputing/projects/gitlab-ci) | [](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/jobs/artifacts/master/file/artifacts/validation/tests/gl-code-quality-report.html?job=PyLint) |
|
|
|:----|:----|:----|
|
|
|
|
| development Branch | [](https://gitlab.com/nofusscomputing/projects/gitlab-ci) | [](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/jobs/artifacts/development/file/artifacts/validation/tests/gl-code-quality-report.html?job=PyLint) |
|
|
|:----|:----|:----|
|
|
|
|
</div>
|
|
|
|
This repository is hosted on [gitlab.com](https://gitlab.com/nofusscomputing/projects/gitlab-ci) and has a read-only copy hosted on [github.com](https://github.com/NoFussComputing/gitlab-ci).
|
|
|
|
links:
|
|
|
|
- [ Issues](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues)
|
|
|
|
- [Merge Requests (Pull Requests)](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/merge_requests)
|
|
|
|
|
|
## Using this repository for your Gitlab CI/CD Jobs.
|
|
This repository has been designed as a central point for your repositories CI/CD jobs. By simply linking this repository to your repository and configuring, your CI/CD jobs will run as part of the build process, whilst keeping any CI/CD commits limited within your git history.
|
|
|
|
Each CI/CD job is contained within its own sub-folder. Each sub-folder has a readme specific to the job, which includes the details on how to implement, use etc.
|
|
|
|
|
|
### gitlab-ci layout
|
|
|
|
We use the following branches:
|
|
- `master` - Considered as the stable branch
|
|
- `development` considered as unstable
|
|
|
|
We also tag each branch to denote the version of release. We use our own repo to do the version increment automagically in line with [semantic versioning](https://semver.org/).
|
|
|
|
|
|
|
|
### CI Stages
|
|
The CI stages for these jobs are as follows, and in the order expected by the jobs:
|
|
|
|
- validation
|
|
> validation of files, commits, Merge Request titles, code quality, license checks.
|
|
|
|
- build
|
|
> build any binaries or files that would be used in the later stages .
|
|
|
|
- prepare
|
|
> any jobs that must run after build but before testing. for example a docker image build that includes artifacts from the build job
|
|
|
|
- test
|
|
> unit, functional, integration and any other tests.
|
|
|
|
- release
|
|
> git tagging and creating a gitlab release. Also includes adding build artifacts to gitlab registry.
|
|
|
|
- sync
|
|
> repository synchronization, i.e. push mirror to github.
|
|
|
|
- publish
|
|
> placement of build objects to external sources
|
|
|
|
|
|
### Artifacts
|
|
Any artifacts by jobs will be created in folders named after the stage.
|
|
|
|
preference is placed on jobs to output JUnit.xml test reports. This is because they are visible in merge requests.
|
|
|
|
|
|
It is recommended that you set-up this repo as a git sub-module to your repo and that you configure it to a set commit/tag. This ensures that any change to `gitlab-ci` repo, does not effect your CI/CD jobs.
|
|
|
|
run the following commands:
|
|
``` bash
|
|
git submodule add -b {ref} https://gitlab.com/nofusscomputing/projects/gitlab-ci.git gitlab-ci
|
|
git submodule update --remote
|
|
|
|
```
|
|
|
|
| :bulb: Tip |
|
|
|:-----|
|
|
| NOTE: `{ref}` should be replaced with the branch name, `master` is the stable branch and recommended. by default the sub-module will be created in folder `gitlab-ci`, it is recommended that you **don't** change this folder name.
|
|
You can also substitute the gitlab url with the github url `https://github.com/NoFussComputing/gitlab-ci.git` for the submodule if you desire. this repo is auto-synced with github on each change to the repo. |
|
|
|
|
After each `git submodule update --remote` you will have to commit the sub-module update to your repo. Suggested commands as follows:
|
|
``` bash
|
|
git add .gitmodules
|
|
|
|
git add gitlab-ci
|
|
|
|
git commit -m "ci(gitlab-ci): updated to use version x
|
|
|
|
{your reason here or explain what is provided/changed}"
|
|
```
|
|
Then push the changes to your source.
|
|
|
|
|
|
## Contributing
|
|
All contributions for this project must conducted from [Gitlab](https://gitlab.com/nofusscomputing/projects/gitlab-ci).
|
|
|
|
For further details on contributing please refer to the [contribution guide](CONTRIBUTING.md).
|
|
|
|
|
|
## Other
|
|
|
|
This repo is release under this [license](LICENSE)
|
|
|