gha3mi / setup-fortran

GitHub action to setup Fortran compiler and toolchain

Setup Fortran

Set up a Fortran compiler on Ubuntu, macOS and Windows runners.

• Usage
• Options
• Outputs
• Environment variables
• Runner compatibility
• License

Usage

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        toolchain:
          - {compiler: gcc, version: 13}
          - {compiler: intel, version: '2023.2'}
          - {compiler: intel-classic, version: '2021.10'}
          - {compiler: nvidia-hpc, version: '23.11'}
        include:
          - os: ubuntu-latest
            toolchain: {compiler: gcc, version: 12}
        exclude:
          - os: macos-latest
            toolchain: {compiler: intel, version: '2023.2'}
          - os: macos-latest
            toolchain: {compiler: nvidia-hpc, version: '23.11'}
          - os: windows-latest
            toolchain: {compiler: nvidia-hpc, version: '23.11'}

    steps:
      - uses: fortran-lang/setup-fortran@v1
        id: setup-fortran
        with:
          compiler: ${{ matrix.toolchain.compiler }}
          version: ${{ matrix.toolchain.version }}

      - run: |
          ${{ env.FC }} ... # environment vars FC, CC, and CXX are set
          ${{ steps.setup-fortran.outputs.fc }} ... # outputs work too

Options

• compiler: Compiler toolchain to setup, available options are
  • gcc (for gfortran)
  • intel (for ifx)
  • intel-classic (for ifort)
  • nvidia-hpc (for nvfortran)
• version: Version of the compiler toolchain. See runner compatibility charts below.

Outputs

The action sets the following outputs:

• fc: Fortran compiler executable, e.g. gfortran
• cc: C compiler executable, e.g. gcc
• cxx: C++ compiler executable, e.g. g++

C/C++ compilers of the same toolchain/version are provided where possible, otherwise (if a standalone Fortran compiler is selected) defaulting to the preinstalled GCC. While this action attempts to guarantee Fortran compiler compatibility with all supported platform/toolchain/version combinations, no corresponding guarantee is made with regard to C/C++ compilers — use at your own risk.

Environment variables

The same values are also set as environment variables:

• FC
• CC
• CXX

These are made available to subsequent workflow steps via the GITHUB_ENV environment file mechanism.

Runner compatibility

Toolchain support varies across GitHub-hosted runner images.

runner	gcc 10	gcc 11	gcc 12	gcc 13	gcc 6	gcc 7	gcc 8	gcc 9	intel-classic 2021.1.2	intel-classic 2021.1	intel-classic 2021.10	intel-classic 2021.2	intel-classic 2021.3	intel-classic 2021.4	intel-classic 2021.5	intel-classic 2021.6	intel-classic 2021.7.1	intel-classic 2021.7	intel-classic 2021.8	intel-classic 2021.9	intel 2021.1.2	intel 2021.1	intel 2021.2	intel 2021.4	intel 2022.0	intel 2022.1	intel 2022.2.1	intel 2022.2	intel 2023.0	intel 2023.1	intel 2023.2
macos-11	✓	✓	✓	✓	✓	✓	✓	✓		✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
macos-12	✓	✓	✓	✓	✓	✓	✓	✓		✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
macos-13	✓	✓	✓	✓		✓	✓	✓		✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
ubuntu-20.04	✓	✓		✓		✓	✓	✓	✓	✓	✓	✓		✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
ubuntu-22.04	✓	✓	✓	✓				✓	✓	✓	✓	✓		✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
windows-2019	✓	✓	✓	✓			✓	✓			✓					✓		✓	✓	✓						✓		✓	✓	✓	✓
windows-2022	✓	✓	✓	✓			✓	✓			✓					✓		✓	✓	✓						✓		✓	✓	✓	✓

Note: on macos-13, gfortran 7-9 require flag -L/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib.

Note: Intel's ifx compiler is not supported on macOS, so the intel option redirects to intel-classic (ifort).

License

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “as is” basis, without warranties or conditions of any kind, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.