Skip to content

CI: Add portability testing on GH Actions using SageMath's reusable workflows #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions .github/workflows/ci-sage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
name: Run Sage CI

## This GitHub Actions workflow provides:
##
## - portability testing, by building and testing this project on many platforms
## (Linux variants, macOS)
##
## - continuous integration, by building and testing other software
## that depends on this project.
##
## It runs on every push to the GitHub repository.
##
## The testing can be monitored in the "Actions" tab of the GitHub repository.
##
## After all jobs have finished (or are canceled) and a short delay,
## tar files of all logs are made available as "build artifacts".
##
## This GitHub Actions workflow uses the portability testing framework
## of SageMath (https://www.sagemath.org/). For more information, see
## https://doc.sagemath.org/html/en/developer/portability_testing.html

## The workflow consists of two jobs:
##
## - First, it builds a source distribution of the project
## and generates a script "update-pkgs.sh". It uploads them
## as a build artifact named upstream.
##
## - Second, it checks out a copy of the SageMath source tree.
## It downloads the upstream artifact and replaces the project's
## package in the SageMath distribution by the newly packaged one
## from the upstream artifact, by running the script "update-pkgs.sh".
## Then it builds a small portion of the Sage distribution.
##
## Many copies of the second step are run in parallel for each of the tested
## systems/configurations.

on:
pull_request:
push:
tags:
branches:
- main
workflow_dispatch:
# Allow to run manually

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

env:
# Ubuntu packages to install so that the project can build an sdist
DIST_PREREQ:
# Name of this project in the Sage distribution
SPKG: soplex
#REMOVE_PATCHES: "*"

jobs:

dist:
runs-on: ubuntu-latest
steps:
- name: Check out ${{ env.SPKG }}
uses: actions/checkout@v3
with:
path: build/pkgs/${{ env.SPKG }}/src
- name: Install prerequisites
run: |
sudo DEBIAN_FRONTEND=noninteractive apt-get update
sudo DEBIAN_FRONTEND=noninteractive apt-get install $DIST_PREREQ
- name: Run make dist, prepare upstream artifact
run: |
(cd build/pkgs/${{ env.SPKG }}/src && git archive --format=tar.gz --prefix=${{ env.SPKG }}-git/ HEAD > ${{ env.SPKG }}-git.tar.gz) \
&& mkdir -p upstream && cp build/pkgs/${{ env.SPKG }}/src/*.tar.gz upstream/${{ env.SPKG }}-git.tar.gz \
&& echo "sage-package create ${{ env.SPKG }} --version git --tarball ${{ env.SPKG }}-git.tar.gz --type=standard" > upstream/update-pkgs.sh \
&& if [ -n "${{ env.REMOVE_PATCHES }}" ]; then echo "(cd ../build/pkgs/${{ env.SPKG }}/patches && rm -f ${{ env.REMOVE_PATCHES }}; :)" >> upstream/update-pkgs.sh; fi \
&& echo 'sed -i.bak s/PAPILO=on/PAPILO=off/ ../build/pkgs/{scip*,soplex}/spkg-install.in; sed -i.bak s/papilo// ../build/pkgs/{scip*,soplex}/dependencies' >> upstream/update-pkgs.sh \
&& ls -l upstream/
- uses: actions/upload-artifact@v3
with:
path: upstream
name: upstream

linux:
# uses: sagemath/sage/.github/workflows/docker.yml@develop
uses: mkoeppe/sage/.github/workflows/docker.yml@scip_9
with:
# Extra system packages to install. See available packages at
# https://github.com/sagemath/sage/tree/develop/build/pkgs
extra_sage_packages: "patch cmake gfortran openblas"
# Sage distribution packages to build
targets: SAGE_CHECK=no SAGE_CHECK_PACKAGES="soplex" soplex
# Standard setting: Test the current beta release of Sage:
sage_repo: sagemath/sage
sage_ref: refs/pull/37494/head
upstream_artifact: upstream
# Docker targets (stages) to tag
docker_targets: "with-targets"
# We prefix the image name with the SPKG name ("scip_sdp_") to avoid the error
# 'Package "sage-docker-..." is already associated with another repository.'
docker_push_repository: ghcr.io/${{ github.repository }}/soplex_
needs: [dist]

macos:
# Use https://github.com/sagemath/sage/pull/37237
uses: mkoeppe/sage/.github/workflows/macos.yml@scip_9
with:
targets: SAGE_CHECK=no SAGE_CHECK_PACKAGES="soplex" soplex
sage_repo: sagemath/sage
sage_ref: refs/pull/37494/head
upstream_artifact: upstream
needs: [dist]