Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update the doc for CI #1421

Merged
merged 4 commits into from
Apr 23, 2024
Merged

update the doc for CI #1421

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
626b515
update the doc
Jingru923 Apr 23, 2024
99e8ac9
Update docs/contribute/ci.qmd
Jingru923 Apr 23, 2024
056ea66
update callout note and mermaid graph
Jingru923 Apr 23, 2024
fc311be
Merge branch 'update-ci-docs' of https://github.com/Deltares/Ribasim …
Jingru923 Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/contribute/ci.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,22 +55,18 @@ We have the following pipeline to generate artifects for releasing:

* Generate Testmodels: produces generated_testmodels artifact which is part of the release.
* Make GitHub Release: uses artifacts and makes the release. TeamCity constantly monitors the Github repository. When a tag starts with `v20` is added, it triggers the release process.
* Build libribasim: builds library of Ribasim on Linux and Windows. The artifact is tested in `Test ribasim_api` and used by iMOD Coupler
* Build ribasim_cli: builds CLI application on Linux and Windows, its artifact is tested in `Test ribasim_cli` and used by release
* Test ribasim_api: tests libribasim artifact on Linux and Windows
* Test ribasim_cli: tests ribasim_cli artifact on Linux and Windows
* Build Ribasim: builds library and executable of Ribasim on Linux and Windows. The artifacts are tested in `Test Ribasim Binaries` and used by iMOD Coupler.
* Test Ribasim Binaries: tests libribasim artifact and ribasim_cli artifact on Linux and Windows

::: {.callout-note}
Make Github Release does not publish artifacts of "Test libribasim" and "Test ribasim_cli". It only publishes artifacts of "Build libribasim" and "Build ribasim_cli" if the beforementioned tests pass.
Make Github Release does not publish artifacts of "Test Ribasim Binaries". It only publishes artifacts of "Build Ribasim" if the beforementioned tests pass.
:::

```{mermaid}
graph LR
A[Make Github Release]-->B(Release)
F[Generate Testmodels]-->A
G[Make QGIS plugin]-->A
H[Build libribasim]---D[Test libribasim]
H[Build Ribasim]---D[Test Ribasim Binaries]
D-->A
C[Build ribasim_cli] --- E[Test ribasim_cli]
E-->A
```
Loading