gmlc-tdc / helics-action Goto Github PK

GMLC-TDC/helics-action/install needs an input option (install_from_source maybe) added to build HELICS from the released source archive instead of an installer. This is a composite run step action located in https://github.com/GMLC-TDC/helics-action/blob/main/install/action.yml that will need changes.

When the input is provided, it should be updated to download the correct version of the source archive (https://github.com/GMLC-TDC/HELICS/releases/download/v3.0.1/Helics-v3.0.1-source.tar.gz has all the submodules included, the default GitHub generated ones do not).

Some dependencies may need to be installed depending on the platform:

• Boost needs to be installed
  • Windows see https://github.com/GMLC-TDC/HELICS/blob/main/.github/actions/common/Windows/install-boost.sh
  • macOS brew install boost could be okay
  • Linux apt-get

When running cmake configure, the following options should probably be given: -DCMAKE_BUILD_TYPE=Release -DHELICS_BUILD_CXX_SHARED_LIB=ON -DHELICS_ZMQ_SUBPROJECT=ON -DSTATIC_STANDARD_LIB=static -DHELICS_BUILD_EXAMPLES=OFF -DBUILD_TESTING=OFF -DHELICS_BUILD_APP_EXECUTABLES=ON -DHELICS_BUILD_APP_LIBRARY=ON -DCMAKE_INSTALL_PREFIX=${prefix}

And then cmake build and install can be run:

cmake --build . --config Release
cmake --build . --config Release --target install

https://docs.helics.org/en/latest/user-guide/installation/build_from_source.html has most of the information on building HELICS from source.

Enable the HELICS action to build a copy of HELICS from source with encryption support.

Run a few hooks in this repository:

• shellcheck
• shfmt
• yaml formatting
• markdown linter/formatting

Some ideas for configuration options:

• Disable ZeroMQ (and other core types that have external dependencies)
• Build without Boost
• Disable building HELICS apps

Add a step to install ninja: - uses: seanmiddleditch/gha-setup-ninja@856654e80dd21909aec244cd01bb96e5c841d64f

Possibly to a temporary destination directory that can be deleted after the workflow runs using the destination input.

helics-action/install is a bit messy with everything in a single yaml file/step. Based on some trial and error, it should be possible to move most of the content from the inline scripts in https://github.com/GMLC-TDC/helics-action/tree/main/install to one or more bash scripts. The steps can then call those scripts by using ${{ github.action_path }} to get the path where GitHub checks out this action to when running it.

Shellcheck should be run on the scripts to identify + fix issues.