Skip to content

Commit 89cf788

Browse files
simonlegrandsimonlegrand
committed
Add status badges
- Minimal and full MPICH on master are exposed in README.md - Details about other versions are in .github/CI.md
1 parent 31888eb commit 89cf788

File tree

2 files changed

+26
-101
lines changed

2 files changed

+26
-101
lines changed

‎.github/CI.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# CI FreeFEM
2+
3+
Each of the subsequent sections correspond to a workflow composed of a set of
4+
jobs: **Release/Debug + different plateform**. A workflow appears as `failed`
5+
if only one of its jobs has failed. To get more details about the failing
6+
configuration, click on the corresponding badge below.
7+
8+
9+
| master | develop |
10+
|:----------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|
11+
| ![Minimal version](https://github.com/FreeFem/FreeFem-sources/actions/workflows/minimal.yml/badge.svg) | ![Minimal version](https://github.com/FreeFem/FreeFem-sources/actions/workflows/minimal.yml/badge.svg?branch=develop) |
12+
| ![Sequential version](https://github.com/FreeFem/FreeFem-sources/actions/workflows/sequential.yml/badge.svg) | ![Sequential version](https://github.com/FreeFem/FreeFem-sources/actions/workflows/sequential.yml/badge.svg?branch=develop) |
13+
| ![Full version OpenMPI](https://github.com/FreeFem/FreeFem-sources/actions/workflows/full-openmpi.yml/badge.svg) | ![Full version OpenMPI](https://github.com/FreeFem/FreeFem-sources/actions/workflows/full-openmpi.yml/badge.svg?branch=develop) |
14+
| ![Full version MPICH](https://github.com/FreeFem/FreeFem-sources/actions/workflows/full-mpich.yml/badge.svg) | ![Full version MPICH](https://github.com/FreeFem/FreeFem-sources/actions/workflows/full-mpich.yml/badge.svg?branch=develop) |
15+
| ![Full version MS-MPI](https://github.com/FreeFem/FreeFem-sources/actions/workflows/full-msmpi.yml/badge.svg) | ![Full version MS-MPI](https://github.com/FreeFem/FreeFem-sources/actions/workflows/full-msmpi.yml/badge.svg?branch=develop) |
16+
17+
GitHub Actions workflows definition files available [here](.github/workflows).

‎README.md

Lines changed: 9 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,13 @@
1515
<!--- along with FreeFEM. If not, see <http://www.gnu.org/licenses/>. --->
1616
<!----------------------------------------------------------------------------------->
1717

18-
<details>
19-
<summary> CI / CD tools </summary>
18+
# FreeFEM Continuous Integration
2019

21-
| LGTM | Coverity |
22-
|:----:|:--------:|
23-
| [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/FreeFem/FreeFem-sources.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FreeFem/FreeFem-sources/context:cpp) | <a href="https://scan.coverity.com/projects/freefem-freefem-sources"><img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/15433/badge.svg"/></a> |
20+
| Minimal version | Full version MPICH |
21+
|:------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------:|
22+
| ![Minimal version](https://github.com/FreeFem/FreeFem-sources/actions/workflows/minimal.yml/badge.svg) | ![Full version MPICH](https://github.com/FreeFem/FreeFem-sources/actions/workflows/full-mpich.yml/badge.svg) |
2423

25-
Jenkins ([FreeFEM-dev](https://ci.inria.fr/freefem-dev/)):
26-
27-
*Develop branch only*
28-
29-
| | macOS | Ubuntu | Windows|
30-
|:-------:|:---------:|:---------:|:------:|
31-
| **Job** | **10.14** | **20.04** | **10** |
32-
| #1 | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-macos1014-job1)](https://ci.inria.fr/freefem-dev/job/FreeFEM-sources-macos1014-job1/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-ubuntu2004-job1)](https://ci.inria.fr/freefem-dev/view/Ubuntu%2020.04/job/FreeFEM-sources-ubuntu2004-job1/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-windows10-job1)](https://ci.inria.fr/freefem-dev/view/Windows%207/job/FreeFEM-sources-windows10-job1/) |
33-
| #2 | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-macos1014-job2)](https://ci.inria.fr/freefem-dev/job/FreeFEM-sources-macos1014-job2/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-ubuntu2004-job2)](https://ci.inria.fr/freefem-dev/view/Ubuntu%2020.04/job/FreeFEM-sources-ubuntu2004-job2/) | |
34-
| #3 |[![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-macos1014-job3)](https://ci.inria.fr/freefem-dev/job/FreeFEM-sources-macos1014-job3/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-ubuntu2004-job3)](https://ci.inria.fr/freefem-dev/view/Ubuntu%2020.04/job/FreeFEM-sources-ubuntu2004-job3/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-windows10-job3)](https://ci.inria.fr/freefem-dev/view/Windows%207/job/FreeFEM-sources-windows10-job3/) |
35-
| #4 (OpenMPI) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-macos1014-job4_openmpi)](https://ci.inria.fr/freefem-dev/job/FreeFEM-sources-macos1014-job4_openmpi/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-ubuntu2004-job4_openmpi)](https://ci.inria.fr/freefem-dev/view/Ubuntu%2020.04/job/FreeFEM-sources-ubuntu2004-job4_openmpi/) | |
36-
| #4 (MPICH) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-macos1014-job4_mpich)](https://ci.inria.fr/freefem-dev/job/FreeFEM-sources-macos1014-job4_mpich/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-ubuntu2004-job4_mpich)](https://ci.inria.fr/freefem-dev/view/Ubuntu%2020.04/job/FreeFEM-sources-ubuntu2004-job4_mpich/) | |
37-
| #4 (MSMPI) | | | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-windows10-job4)](https://ci.inria.fr/freefem-dev/view/Windows%207/job/FreeFEM-sources-windows10-job4/) |
38-
| #5 (OpenMPI) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-macos1014-job5_openmpi)](https://ci.inria.fr/freefem-dev/job/FreeFEM-sources-macos1014-job5_openmpi/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-ubuntu2004-job5_openmpi)](https://ci.inria.fr/freefem-dev/view/Ubuntu%2020.04/job/FreeFEM-sources-ubuntu2004-job5_openmpi/) | |
39-
| #5 (MPICH) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-macos1014-job5_mpich)](https://ci.inria.fr/freefem-dev/job/FreeFEM-sources-macos1014-job5_mpich/) | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-ubuntu2004-job5_mpich)](https://ci.inria.fr/freefem-dev/view/Ubuntu%2020.04/job/FreeFEM-sources-ubuntu2004-job5_mpich/) | |
40-
| #5 (MSMPI) | | | [![Build Status](https://ci.inria.fr/freefem-dev/buildStatus/icon?job=FreeFEM-sources-windows10-job5)](https://ci.inria.fr/freefem-dev/view/Windows%207/job/FreeFEM-sources-windows10-job5/) |
41-
42-
Jenkins ([FreeFEM](https://ci.inria.fr/freefem/)):
43-
44-
*Master branch*
45-
46-
| Release | .pkg | AppImage | .deb | .exe | Docker |
47-
|:-------:|:----:|:--------:|:----:|:----:|:------:|
48-
| [![Build Status](https://ci.inria.fr/freefem/buildStatus/icon?job=FreeFEM-sources-createRelease)](https://ci.inria.fr/freefem/view/Master/job/FreeFEM-sources-createRelease/) | [![Build Status](https://ci.inria.fr/freefem/buildStatus/icon?job=FreeFEM-sources-deployPKG)](https://ci.inria.fr/freefem/view/Master/job/FreeFEM-sources-deployPKG/) | [![Build Status](https://ci.inria.fr/freefem/buildStatus/icon?job=FreeFEM-sources-deployAppImage)](https://ci.inria.fr/freefem/view/Master/job/FreeFEM-sources-deployAppImage/) | [![Build Status](https://ci.inria.fr/freefem/buildStatus/icon?job=FreeFEM-sources-deployDEB)](https://ci.inria.fr/freefem/view/Master/job/FreeFEM-sources-deployDEB/) | [![Build Status](https://ci.inria.fr/freefem/buildStatus/icon?job=deployEXE)](https://ci.inria.fr/freefem/view/Master/job/deployEXE/) | [![Build Status](https://ci.inria.fr/freefem/buildStatus/icon?job=FreeFEM-docker)](https://ci.inria.fr/freefem/view/Docker/job/FreeFEM-docker/) |
49-
50-
See [CI/CD Tools](#cicd-tools)
51-
</details>
24+
More details [here](.github/CI.md).
5225

5326
# FreeFEM sources
5427

@@ -65,6 +38,7 @@ The user documentation is available [here](https://github.com/FreeFem/FreeFem-do
6538
If you use FreeFEM for academic research, please use the following:
6639

6740
**BibTeX:**
41+
6842
```
6943
@article{MR3043640,
7044
AUTHOR = {Hecht, F.},
@@ -81,16 +55,19 @@ If you use FreeFEM for academic research, please use the following:
8155
```
8256

8357
**APA:**
58+
8459
```
8560
Hecht, F. (2012). New development in FreeFem++. Journal of numerical mathematics, 20(3-4), 251-266.
8661
```
8762

8863
**ISO 690:**
64+
8965
```
9066
HECHT, Frédéric. New development in FreeFem++. Journal of numerical mathematics, 2012, vol. 20, no 3-4, p. 251-266.
9167
```
9268

9369
**MLA:**
70+
9471
```
9572
Hecht, Frédéric. "New development in FreeFem++." Journal of numerical mathematics 20.3-4 (2012): 251-266.
9673
```
@@ -102,72 +79,3 @@ All development efforts take place in the _develop_ branch (or in feature branch
10279
**Do not commit on master branch!**
10380

10481
Have a look on the [Wiki](https://github.com/FreeFem/FreeFem-sources/wiki)!
105-
106-
## CI/CD Tools
107-
108-
### FreeFEM-dev
109-
110-
See [Jenkins configuration files](etc/jenkins)
111-
112-
### FreeFEM
113-
114-
All: all dependency packages are installed (computer with root access).<br/>
115-
No: dependency packages are not installed (computer without root access).
116-
117-
<sup>1</sup>: Ubuntu 18.04 x86
118-
119-
<sup>2</sup>: macOS 10.13
120-
121-
<sup>3</sup>: macOS 10.9
122-
123-
<sup>4</sup>: Windows 7 + MSYS2 + MS MPI 7
124-
125-
__Executed commands:__
126-
127-
Automatic configuration:
128-
129-
```bash
130-
autoreconf -i
131-
```
132-
133-
Configuration:
134-
135-
```bash
136-
./configure --enable-download --enable-optim
137-
```
138-
139-
If you do not have administrator rights or do not want FreeFEM files scattered around on your machine, please use the `--prefix` option, e.g.:
140-
141-
```bash
142-
./configure --enable-download --enable-optim --prefix=${HOME}/FreeFem-install
143-
```
144-
145-
Download:
146-
147-
```bash
148-
./3rdparty/getall -a
149-
```
150-
151-
PETSc:
152-
153-
```bash
154-
cd 3rdparty/ff-petsc
155-
make petsc-slepc
156-
cd -
157-
./reconfigure
158-
```
159-
160-
Make:
161-
162-
```bash
163-
make -j2
164-
make check
165-
```
166-
167-
Install:
168-
169-
```bash
170-
(sudo) make install
171-
```
172-
173-
See [CI/CD Tools Wiki](https://github.com/FreeFem/FreeFem-sources/wiki/CI-CD-Tools) for more informations.

0 commit comments

Comments
 (0)