diff --git a/README.md b/README.md index bbbb3ad072fe454b067fec41ad8e9fafaf62fb93..0d09748f30a79d083ee9336f6cc602f9f6796b6f 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,9 @@ The CI files contain all the ci jobs that are used in most repositories. Here is ```console .gitlab ├── ci +│ ├── code_quality +│ │ ├── cpp.gitlab-ci.yml +│ │ └── python.gitlab-ci.yml │ ├── default.gitlab-ci.yml │ ├── download │ │ ├── download.gitlab-ci.yml @@ -20,12 +23,11 @@ The CI files contain all the ci jobs that are used in most repositories. Here is │ ├── release │ │ ├── cibuildwheel_ubuntu.gitlab-ci.yml │ │ ├── cibuildwheel_windows.gitlab-ci.yml +│ │ ├── deploy.gitlab-ci.yml │ │ ├── pip.gitlab-ci.yml │ │ └── template.gitlab-ci.yml │ ├── rules.gitlab-ci.yml -│ ├── static_analysis -│ │ ├── cpp.gitlab-ci.yml -│ │ └── python.gitlab-ci.yml +│ ├── shared_script.gitlab-ci.yml │ ├── ubuntu_cpp.gitlab-ci.yml │ ├── ubuntu_python.gitlab-ci.yml │ ├── windows_cpp.gitlab-ci.yml @@ -33,7 +35,8 @@ The CI files contain all the ci jobs that are used in most repositories. Here is ├── issue_templates │ ├── Default.md │ ├── Documentation.md -│ └── Feature.md +│ ├── Feature.md +│ └── User-Request.md └── merge_request_templates └── Default.md ``` @@ -41,7 +44,7 @@ The CI files contain all the ci jobs that are used in most repositories. Here is ### **ci** Contains all the common jobs for aidge pipelines. -- **`default`**,**`rules`** & **`download/*`** Contains templating jobs. They are not executed (because their names are prepended with a `.`) and either serve as : +- **`default`**,**`rules`** & **`download/*`** Contains templating jobs. They are not executed directly (because their names are prepended with a `.`) and either serve as : 1. Template for other jobs. These templates are invoked with following syntax : ```yml extends: @@ -54,7 +57,7 @@ Contains all the common jobs for aidge pipelines. ``` - **`release/*` :** Contains all jobs related to release - - **`static_analysis/*` :** Contains all jobs related to static_analysis + - **`code_quality/*` :** Contains all jobs related to static_analysis, formatting check, coverage, etc... ### **issue && merge_requests_templates** Contains all templates for issues & merge requests of `aidge_group`.