Skip to content
Snippets Groups Projects
Commit c0795a8a authored by Grégoire Kubler's avatar Grégoire Kubler
Browse files

chore : upd readme

parent 263b766b
No related branches found
No related tags found
1 merge request!10Code formatting
...@@ -12,6 +12,9 @@ The CI files contain all the ci jobs that are used in most repositories. Here is ...@@ -12,6 +12,9 @@ The CI files contain all the ci jobs that are used in most repositories. Here is
```console ```console
.gitlab .gitlab
├── ci ├── ci
│ ├── code_quality
│ │ ├── cpp.gitlab-ci.yml
│ │ └── python.gitlab-ci.yml
│ ├── default.gitlab-ci.yml │ ├── default.gitlab-ci.yml
│ ├── download │ ├── download
│ │ ├── download.gitlab-ci.yml │ │ ├── download.gitlab-ci.yml
...@@ -20,12 +23,11 @@ The CI files contain all the ci jobs that are used in most repositories. Here is ...@@ -20,12 +23,11 @@ The CI files contain all the ci jobs that are used in most repositories. Here is
│ ├── release │ ├── release
│ │ ├── cibuildwheel_ubuntu.gitlab-ci.yml │ │ ├── cibuildwheel_ubuntu.gitlab-ci.yml
│ │ ├── cibuildwheel_windows.gitlab-ci.yml │ │ ├── cibuildwheel_windows.gitlab-ci.yml
│ │ ├── deploy.gitlab-ci.yml
│ │ ├── pip.gitlab-ci.yml │ │ ├── pip.gitlab-ci.yml
│ │ └── template.gitlab-ci.yml │ │ └── template.gitlab-ci.yml
│ ├── rules.gitlab-ci.yml │ ├── rules.gitlab-ci.yml
│ ├── static_analysis │ ├── shared_script.gitlab-ci.yml
│ │ ├── cpp.gitlab-ci.yml
│ │ └── python.gitlab-ci.yml
│ ├── ubuntu_cpp.gitlab-ci.yml │ ├── ubuntu_cpp.gitlab-ci.yml
│ ├── ubuntu_python.gitlab-ci.yml │ ├── ubuntu_python.gitlab-ci.yml
│ ├── windows_cpp.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 ...@@ -33,7 +35,8 @@ The CI files contain all the ci jobs that are used in most repositories. Here is
├── issue_templates ├── issue_templates
│ ├── Default.md │ ├── Default.md
│ ├── Documentation.md │ ├── Documentation.md
│ └── Feature.md │ ├── Feature.md
│ └── User-Request.md
└── merge_request_templates └── merge_request_templates
└── Default.md └── Default.md
``` ```
...@@ -41,7 +44,7 @@ The CI files contain all the ci jobs that are used in most repositories. Here is ...@@ -41,7 +44,7 @@ The CI files contain all the ci jobs that are used in most repositories. Here is
### **ci** ### **ci**
Contains all the common jobs for aidge pipelines. 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 : 1. Template for other jobs. These templates are invoked with following syntax :
```yml ```yml
extends: extends:
...@@ -54,7 +57,7 @@ Contains all the common jobs for aidge pipelines. ...@@ -54,7 +57,7 @@ Contains all the common jobs for aidge pipelines.
``` ```
- **`release/*` :** Contains all jobs related to release - **`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** ### **issue && merge_requests_templates**
Contains all templates for issues & merge requests of `aidge_group`. Contains all templates for issues & merge requests of `aidge_group`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment