diff --git a/doc/index.rst b/doc/index.rst index 24a879e56..cd5b554b7 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -694,6 +694,41 @@ Since v0.6.0, you can run locally using ``.travis.yml`` you already defined for rosrun industrial_ci run_travis --help +Run locally using GitHub-Workflow config +++++++++++++++++++++++++++++++++++++++++ + +Since you can run locally GitHub actions using industrial_ci. + +In general, to run GH-Actions locally, you need [`act`](https://github.com/nektos/act). +For its installation, follow the [official install instructions](https://github.com/nektos/act#installation). +Installation in short: +* install docker engine; +* install `act` using [bash script](https://github.com/nektos/act#bash-script) (tested on Ubuntu and its derivatives); +* When asked about `act` image you would like to install, choose medium (default choice). + +Before running a GH-Action locally, please check that you are using the `industrial_ci` as follows: +``` + - uses: ros-industrial/industrial_ci@master + with: + config: ${{toJSON(matrix.env)}} +``` + +Often used configuration is actually not supported by GH (more details in #590) +``` + - uses: ros-industrial/industrial_ci@master + env: ${{matrix.env}} + ``` + +After that, go to the package you would like to test and start a workflow using act: +- `act` - execute all workflows +- `act -l` - list all defined workflows +- `act -j