Skip to content

Commit

Permalink
Document running actions locally
Browse files Browse the repository at this point in the history
  • Loading branch information
MakisH committed Jan 30, 2025
1 parent 11378fa commit 10e0097
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.secrets
8 changes: 8 additions & 0 deletions .github/workflows/build-custom.input
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
virtualEnvironment="ubuntu-22.04"
refAdapter="develop"
versionOpenFOAM="2412"
versionpreCICE="v3.1.2"
runTutorialHeatedPlate="false"
runTutorialQuickstart="false"
runTutorialPartitionedPipe="false"
branchTutorials="develop"
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,23 @@ There are also a few additional workflows that can be triggered manually:

Members of the repository can trigger these workflows in the "Actions" tab.

### Running the CI locally

You can also run GitHub Actions locally with [act](https://github.com/nektos/act).

List the workflows with `act --list`. To simulate a push event, run `act push`. Some workflows might work on GitHub Actions but not on act, in which case you could try running specific workflows with, for example, `act -j 'build'`.

To trigger the custom build workflow:

1. Switch to the directory `.github/workflows/`
2. Edit the inputs in the `build-custom.input` file.
3. [Generate a GitHub access token](https://github.com/settings/personal-access-tokens) and add it to a `.secrets` file with content `GITHUB_TOKEN=<your-token>`.
4. Start the build using:

```shell
act -W build-custom.yml --input-file build-custom.input --secret-file .secrets --artifact-server-path $PWD/.artifacts
```

## System tests

For non-trivial pull requests, we also need to execute [system regression tests](https://precice.org/dev-docs-system-tests.html),
Expand Down

0 comments on commit 10e0097

Please sign in to comment.