Commit 72519fdb authored by David Diederich's avatar David Diederich
Browse files

Merge branch 'documenation-update' into 'master'

README update

See merge request !63
parents 00f32015 0bda2be1
Pipeline #8912 passed with stages
in 15 seconds

133 KB


137 KB

# CI-CD Pipelines
# OSDU CI/CD Pipeline Overview
Find the most recent documentation build [here](
Find the most recent documentation build [here](
A common place for shared CI/CD Pipeline files, for use will all OSDU projects.
![alt text](CI-CD.png "CI/CD Pipeline")
\ No newline at end of file
[The OSDU Platform project]( (including sub-projects) makes use of [GitLab's built-in CI/CD capabilities]( to provide a CI/CD pipeline that runs automatically on commits to the project. The stages in the pipeline include:
- Security scanning for known vulnerabilities (CVEs)
- Scanning for use of approved Licenses in submitted code and dependencies
- Correct attribution of the submitted material
- Unit tests
- Integration tests
## Common Practices / Definitions
**Continuous Integration**
* Developers merge/integrate the code to Master as soon as developer made a progress on the feature. Usually everyone commits to the Master every day.
* Continuous Integration assumes a high degree of tests which are automated into the software. we have good automated testing coverage as we progress we need to add more test cases.
* Continuous Integration refers to Integrating code, building and testing code (Unit and Integration tests) within the development environment.
**Continuous Delivery**
* Continuous Delivery means that you are able to do frequent deployments to a testing environment and/or production environment but may choose not to do it, due to various reasons (Ex: businesses not ready or OSDU applicatiions not ready)
**Continuous Deployment**
* Continuous Deployment means that every change goes through the pipeline and automatically (No manual approval) gets put into production, resulting in many production deployments every day.
## A graphical overview of the CI/CD Pipeline:
**Continuous Delivery is not ready and its just an idea for now but we will have to figure out how & where to run UAT and Performance tests.**
**Continuous Deployment might not be applicable for OSDU.**
![alt text](CD1.jpg "CI/CD Pipeline")
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment