Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 0 additions & 9 deletions CONTRIBUTING

This file was deleted.

12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Welcome to the MFEM GitHub actions repository

The github actions in this repo are used in several projects.

The projects mentioned in [README.md](README.md) are considered critical users of this repo. When introducing a change in this repo,
care should be taken to check that those will not break the CI process of the critical users.

The verification process is as follow:
- Create a branch with the changes in the GitHub actions. Push this branch to the GitHub repo.
- Create branches out of current master in the projects mentioned in [README.md](README.md). In those branches, point the GitHub actions to your new branch.
- Create pull requests, marked as `do-not-merge` in the projects so that CI is triggered with your new changes.
- Once working, submit a PR to the GitHub actions repo.
16 changes: 0 additions & 16 deletions README

This file was deleted.

16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Welcome to the MFEM GitHub actions repository

The goal of this repository is to gather the GitHub actions used by MFEM, projects related to MFEM, or any other project
interested in using them. Keeping these in one repo avoids duplicating and maintaining several copies of similar actions.

Projects using these actions:
- [mfem/mfem](https://github.com/mfem/mfem)
- [glvis/glvis](https://github.com/glvis/glvis)
- [ceed/laghos](https://github.com/ceed/laghos)
- [ceed/remhos](https://github.com/ceed/remhos)

Description of the actions:
- [`build-hypre`](build-hypre/action.yml) will download and build hypre with some degree of configuration, dictated by mfem typical usage.
- [`build-metis`](build-metis/action.yml) will download and build metis with some degree of configuration, dictated by mfem typical usage.
- [`build-mfem`](build-mfem/action.yml) will download and build mfem. This one has more configuration options, since we want to enable building various mfem configurations. It is also intended to build mfem both as the main project (in mfem CI) or as a dependency, in which case one can control what repo and branch to use.
- [`upload-coverage`](upload-coverage/action.yml) is a standard action to upload coverage information to codecov.
7 changes: 4 additions & 3 deletions build-mfem/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,10 @@ runs:
if [[ ${{ inputs.target }} == 'dbg' ]]; then
DEBUG="YES";
BUILD_TYPE="Debug";
if [[ ${{ inputs.os }} == 'ubuntu-18.04' ]]; then
CPPFLAGS+=" -pedantic -Wall -Werror";
fi
fi
if [[ ${{ inputs.os }} != 'ubuntu-18.04' || \
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, this is what was done in travis, my bad.
However, do we really want this for the optim target too?
Also, maybe it is a good idea to keep this on the linux target, because macos resource is limited...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we really want this for the optim target too?

I don't think it hurts to add these flags for the opt build -- at least with clang (which is the compiler on mac). With gcc (on linux) adding these flags to the -O3 flag results in more warnings (compared to no optimization flags) that can be quite different from one version of gcc to another -- that's why the warning flags are disabled on linux with opt build.

Also, maybe it is a good idea to keep this on the linux target, because macos resource is limited...

Do you think adding these flags makes the compilation slower? I'd be surprised if there is any noticeable slowdown.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think we want this on mac because it catches issues that are not caught by gcc -- I noticed the difference with Travis because in one instance (#1492), Travis failed (due to warning failures on mac) while the github actions were clean.

${{ inputs.target }} == 'dbg' ]]; then
CPPFLAGS+=" -pedantic -Wall -Werror";
fi
echo "[STATUS] DEBUG: ${DEBUG}"
echo "[STATUS] BUILD_TYPE: ${BUILD_TYPE}"
Expand Down