build-pkg

This GitHub action builds a GAP package.

Usage

The action build-pkg has to be called by the workflow of a GAP package. It compiles the package.

Inputs

All of the following inputs are optional.

• coverage:
  • Boolean that determines whether code coverage is turned on by adding --coverage to CFLAGS, CXXFLAGS and LDFLAGS.
  • default: 'true'
• CONFIGFLAGS:
  • Additional arguments to be passed to configure.
  • default: ''
• build-needed-pkgs:
  • Build packages needed by this package. Options are: true, false, recursive.
  • default: 'recursive'
• build-suggested-pkgs:
  • Build packages suggested by this package. Options are: true, false, recursive.
  • default: 'true'
• build-extensions:
  • Build packages needed for extensions by this package. Options are: true, false, recursive.
  • default: 'true'

What's new in v3

• The inputs build-needed-pkgs, build-suggested-pkgs and build-extensions were added. Setting these to true will also compile the relevant dependencies, and setting them to recursive will also compile the dependencies' dependencies, etc.

What's new in v2

• The environment variable NO_COVERAGE was replaced by the action input coverage. To disable compiling code with coverage collection enabled, previously one had to set NO_COVERAGE to any non-empty value. This can now be achieved by setting the coverage input to false.

Examples

See below for a minimal example to run this action.

Minimal example

name: CI

# Trigger the workflow on push or pull request
on:
  push:
  pull_request:

jobs:
  test:
    name: Test
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6
      - uses: gap-actions/setup-gap@v3
      - uses: gap-actions/build-pkg@v3

Contact

Please submit bug reports, suggestions for improvements and patches via the issue tracker.

License

The action build-pkg is free software; you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your opinion) any later version. For details, see the file LICENSE distributed with this action or the FSF's own site.