diff --git a/README.md b/README.md index a3b35b6eed86275fd4a39731af3deddf52f8987a..300440919a4bd21d3158367ab3f410eb45e29f2a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@ # CI templates for R2DevOps open source catalog -This repository contains CI templates dedicated to Python software testing for the R2DevOps open source catalog. +This repository contains CI templates dedicated to Python software testing for the +R2DevOps open source catalog. ## Purpose -The CI templates in this repository are intended for integrating Python software testing tools with your GitLab projects. They provide streamlined configurations for tools like `pytest` and `mypy`. + +The CI templates in this repository are intended for integrating Python software testing +tools with your GitLab projects. They provide streamlined configurations for tools +like `pytest` and `mypy`. ## Usage + To utilize these templates in your GitLab projects: -1. Navigate to the [r2devops template marketplace](https://r2devops.io/dashboard/marketplace?search=r2_metadata), +1. Navigate to + the [r2devops template marketplace](https://r2devops.io/dashboard/marketplace?search=r2_metadata), 2. Choose the template you want, 3. Paste the "Quick use" snippet into your GitLab CI configuration (`.gitlab-ci.yml`). @@ -16,20 +22,24 @@ For example, to use the `pytest` template: ```yaml stages: - - test + - test include: - - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba/r2devops_catalog/r2_metadata/pytest@latest.yaml' + - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba/r2devops_catalog/r2_metadata/pytest@latest.yaml' ``` ## Contributions -We welcome contributions from the community! For guidelines on contributing, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file. + +We welcome contributions from the community! For guidelines on contributing, please +refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file. ## Prerequisites -To use the templates from this repository, ensure that you have at least GitLab version `15.10.7`. + +To use the templates from this repository, ensure that you have at least GitLab +version `15.10.7`. ## Directory Structure + - `r2_metadata` - Contains the R2DevOps metadata files. - `templates` - Contains the CI templates. - `test` - Contains test projects used to test each template. -k \ No newline at end of file