Skip to content

Create a GitHub Actions setup: build documentation, executables on Linux and MacOS #1049

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.

Sign up for GitHub

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
kipiberbatov wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Create a GitHub Actions setup: build documentation, executables on Linux and MacOS #1049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39d5f66
Deploy documentation to GitHub Pages
kipiberbatov Dec 19, 2025
c87a6bf
Build Neper on Linux via GitHub Actions
kipiberbatov Dec 17, 2025
508aff3
Build Neper on MacOS via GitHub Actions
kipiberbatov Dec 17, 2025
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
13 changes: 13 additions & 0 deletions .github/scripts/check-pages-enabled.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
echo "Checking for existence of environment: 'github-pages'"

HTTP_STATUS=$(curl --write-out "%{http_code}" --silent --output /dev/null \
--header "Accept: application/vnd.github.v3+json" \
"https://api.github.com/repos/$GITHUB_REPOSITORY/environments/github-pages")

if [[ "$HTTP_STATUS" -eq 200 ]]; then
echo "Environment 'github-pages' found."
echo "enabled=true" >> "$GITHUB_OUTPUT"
else
echo "Environment 'github-pages' does not exist (HTTP status: $HTTP_STATUS)."
echo "enabled=false" >> "$GITHUB_OUTPUT"
fi
50 changes: 50 additions & 0 deletions .github/workflows/linux.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Build Neper executable on Linux for arm64 and x86_64

on:
workflow_call:

jobs:
build:
name: Build Neper executable on Linux
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-24.04-arm
arch: arm64
- os: ubuntu-24.04
arch: x86_64

steps:
- name: Update apt-get
run: sudo apt-get update

- name: Checkout
uses: actions/checkout@v6

- name: Install GNU Scientific Library
run: sudo apt-get install libgsl-dev

- name: Create build directory
run: mkdir -p src/build

- name: Generate Makefile
working-directory: src/build
run: cmake ..

- name: Build Neper executable
working-directory: src/build
run: make

- name: Run tests
continue-on-error: true
working-directory: src/build
run: ctest

- name: Upload Neper executable
uses: actions/upload-artifact@v6
with:
name: neper-linux-${{ matrix.arch }}
path: src/build/neper
retention-days: ${{ github.event.repository.private && 1 || 7 }}
62 changes: 62 additions & 0 deletions .github/workflows/macos.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Build Neper executable on MacOS for arm64 and x86_64

on:
workflow_call:

jobs:
build:
name: Build Neper executable on MacOS
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
include:
- os: macos-15
arch: arm64
- os: macos-15-intel
arch: x86_64

steps:
- name: Checkout
uses: actions/checkout@v6

- name: Install GNU Scientific Library
run: brew install gsl

- name: Install OpenMP
run: brew install libomp

- name: Create build directory
run: mkdir -p src/build

- name: Generate Makefile
working-directory: src/build
env:
MACOSX_DEPLOYMENT_TARGET: 10.15
run: |
export LDFLAGS="-L$(brew --prefix libomp)/lib"
cmake \
-DCMAKE_C_COMPILER=$(brew --prefix llvm@18)/bin/clang \
-DCMAKE_CXX_COMPILER=$(brew --prefix llvm@18)/bin/clang++ \
-DOpenMP_C_FLAGS="-fopenmp -I$(brew --prefix libomp)/include" \
-DOpenMP_CXX_FLAGS="-fopenmp -I$(brew --prefix libomp)/include" \
-DOpenMP_C_LIB_NAMES="omp" \
-DOpenMP_CXX_LIB_NAMES="omp" \
-DOpenMP_omp_LIBRARY=$(brew --prefix libomp)/lib/libomp.dylib \
..

- name: Build Neper executable
working-directory: src/build
run: make

- name: Run tests
continue-on-error: true
working-directory: src/build
run: ctest

- name: Upload Neper executable
uses: actions/upload-artifact@v6
with:
name: neper-macos-${{ matrix.arch }}
path: src/build/neper
retention-days: ${{ github.event.repository.private && 1 || 7 }}
23 changes: 23 additions & 0 deletions .github/workflows/runner.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Run all jobs

on:
workflow_dispatch:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
website:
name: Website
uses: ./.github/workflows/website.yaml

linux:
name: Linux
uses: ./.github/workflows/linux.yaml

macos:
name: MacOS
uses: ./.github/workflows/macos.yaml
77 changes: 77 additions & 0 deletions .github/workflows/website.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: Build HTML documentation and deploy the website to GitHub Pages

on:
workflow_call:

jobs:
build-website:
name: Build website with Sphinx using a theme provided by Read the Docs
runs-on: ubuntu-latest
steps:
- name: Update apt-get
run: sudo apt-get update

- name: Set up Git repository
uses: actions/checkout@v6

- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.13'

- name: Install pip
run: python -m pip install --upgrade pip

- name: Install Sphinx Read The Docs
run: pip install sphinx

- name: Install Read the Docs theme for Sphinx
run: pip install sphinx-rtd-theme

- name: Build website
working-directory: doc
run: make html

- name: Upload website
uses: actions/upload-pages-artifact@v4
with:
path: doc/build/html
retention-days: ${{ github.event.repository.private && 1 || 7 }}

check-pages-status:
name: Check whether GitHub Pages is enabled
runs-on: ubuntu-latest
outputs:
enabled: ${{ steps.check-pages.outputs.enabled }}
steps:
- name: Checkout repository
uses: actions/checkout@v6

- name: Check if GitHub Pages is enabled
id: check-pages
run: bash .github/scripts/check-pages-enabled.sh

deploy-website:
name: Deploy to GitHub Pages
needs: [build-website, check-pages-status]
if: >
needs.check-pages-status.outputs.enabled == 'true' &&
github.event_name != 'pull_request'
permissions:
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false

runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Set up GitHub Pages
uses: actions/configure-pages@v5

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4