Skip to content

CI/CD

CI/CD (Continuous Integration/Continuous Deployment) is the automated building, testing, and deployment of your application. Every time you change your code, it is automatically tested and prepared for use. This ensures your application stays up to date and that problems are discovered quickly, without having to do everything manually.

For this product, you describe how you implemented CI/CD in your project, which steps are executed, and how this contributes to the quality of your application.

CI/CD

CI/CD consists of two important parts:

  • Continuous Integration (CI): Automatically building and testing your code when changes are made
  • Continuous Deployment (CD): Automatically deploying your application to a production environment

By using CI/CD you ensure that:

  • Code changes are tested immediately
  • Problems are discovered quickly
  • The application is updated automatically
  • Code quality is safeguarded

There are various tools you can use for CI/CD, such as GitLab CI/CD, Jenkins, or CircleCI.

Quality indicators

When assessing this product, the following quality indicators will be considered:

  • The CI/CD document is self-contained: it starts with an introduction/context and then describes the different parts of CI/CD.
  • There is an overview of which CI/CD pipeline is implemented and which steps are executed.
  • It explains why CI/CD was implemented and how it contributes to the quality of the application.
  • It describes which tools and services are used for CI/CD (for example GitLab CI/CD, etc.).
  • It includes a description of all steps in the pipeline (build, test, deploy, etc.).
  • It includes examples of the CI/CD configuration (for example YAML files) that make it clear how the pipeline works.
  • It includes screenshots or example output showing that the CI/CD pipeline runs successfully.
  • It includes references to the code in GitLab where the CI/CD configuration lives.
  • It includes a list of sources used to implement CI/CD.

Template

To document CI/CD yourself, you can use the following template:

# CI/CD

In this section, describe in a few sentences what CI/CD is and why it is important for your project. This is the main text of your document.

## CI/CD Pipeline

Here you describe which CI/CD pipeline you implemented and which steps are executed. Explain why you chose this approach and how it contributes to the quality of your application.

## Tools and Services

Here you describe which tools and services you use for CI/CD. Explain why you chose these tools and how they work.

## Pipeline Steps

Here you describe all steps in the pipeline. For example:
- Build: Compiling or building your application
- Test: Running automated tests
- Lint: Checking code quality
- Deploy: Deploying your application to an environment

For each step, explain what happens and why it is important.

## Configuratie

Here you add the CI/CD configuration (for example YAML files) that make it clear how the pipeline works. Explain what each step does and why this configuration was chosen.
Add references to the code in GitLab and use code snippets to describe the configuration.

## Resultaten

Here you add screenshots or example output showing that the CI/CD pipeline runs successfully. For example, a screenshot of a successful build or an overview of test results.

## Bronnen

List here the sources you used to implement CI/CD. Think of YouTube videos, websites, books, and so on.
Also include sources that helped you write the code.