Update README files; add gh-action example files
This commit is contained in:
Ralph Lange
57
github-actions/README.md
Normal file
57
github-actions/README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# GitHub Actions Scripts for EPICS Modules
|
||||
|
||||
## Features
|
||||
|
||||
- 20 parallel runners on Linux/Windows (5 runners on MacOS)
|
||||
- Ubuntu 16/18/20, MacOS 10.15, Windows Server 2016/2019
|
||||
- Compile natively on Linux (gcc, clang)
|
||||
- Compile natively on MacOS (clang)
|
||||
- Compile natively on Windows (gcc/MinGW, Visual Studio 2017 & 2019)
|
||||
- Cross-compile for Windows 32bit and 64bit using MinGW and WINE
|
||||
- Cross-compile for RTEMS 4.9 and 4.10 (Base >= 3.15)
|
||||
- Caching not supported yet.
|
||||
|
||||
## How to Use these Scripts
|
||||
|
||||
1. Add the ci-scripts respository as a Git Submodule
|
||||
(see [README](../README.md) one level above).
|
||||
|
||||
2. Add settings files defining which dependencies in which versions
|
||||
you want to build against
|
||||
(see [README](../README.md) one level above).
|
||||
|
||||
3. Create a GitHub Actions configuration by copying one of the workflow
|
||||
examples into the directory `.github/workflows` of your module.
|
||||
```bash
|
||||
$ mkdir -p .github/workflows
|
||||
$ cp .ci/github-actions/ci-scripts-build.yml.example-full .github/workflows/ci-scripts-build.yml
|
||||
```
|
||||
|
||||
4. Edit the workflow configuration to include the build jobs you want
|
||||
GitHub Actions to run.
|
||||
|
||||
Build jobs are specified in the `jobs: <job-name>: strategy:`
|
||||
declaration. The `matrix:` element specifies the axes as configuration
|
||||
parameters with their lists of values,
|
||||
`env:` (on the build level) controls the setting of environment variables
|
||||
(which can be matrix parameters).
|
||||
The `runs-on:` setting specifies the image (operating system) of the
|
||||
runner.
|
||||
The `name:` is what shows up in the web interface for the workflow,
|
||||
builds and jobs, and the elements under `steps:` describe the actions
|
||||
executed for each job of the matrix.
|
||||
|
||||
Please check the comments in the examples for more hints, and the
|
||||
[GitHub Actions documentation](https://help.github.com/en/actions)
|
||||
for a lot more options and details.
|
||||
|
||||
5. Push your changes and click on the `Actions` tab of your GitHub repository
|
||||
page to see your build results.
|
||||
|
||||
## Caches
|
||||
|
||||
GitHub Actions provides caching of dependencies.
|
||||
|
||||
However, since their cache restore and create algorithm is fundamentally
|
||||
different from those used by Travis and AppVeyor, this will require some
|
||||
more changes in ci-scripts to work. Be patient.
|
||||
155
github-actions/ci-scripts-build.yml.example-full
Normal file
155
github-actions/ci-scripts-build.yml.example-full
Normal file
@@ -0,0 +1,155 @@
|
||||
# .github/workflows/ci-scripts-build.yml for use with EPICS Base ci-scripts
|
||||
# (see: https://github.com/epics-base/ci-scripts)
|
||||
|
||||
# This is YAML - indentation levels are crucial
|
||||
|
||||
# Set the 'name:' properties to values that work for you (MYMODULE)
|
||||
|
||||
name: MYMODULE ci-scripts build
|
||||
|
||||
# Trigger on pushes and PRs to any branch
|
||||
on: [push, pull_request]
|
||||
|
||||
env:
|
||||
SETUP_PATH: .ci-local:.ci
|
||||
SET: test01
|
||||
CMP: gcc
|
||||
# For the sequencer on Linux/Windows/MacOS
|
||||
APT: re2c
|
||||
CHOCO: re2c
|
||||
BREW: re2c
|
||||
|
||||
jobs:
|
||||
build-linux:
|
||||
name: ${{ matrix.cmp }} / ${{ matrix.configuration }} / ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
# Set environment variables from matrix parameters
|
||||
env:
|
||||
CMP: ${{ matrix.cmp }}
|
||||
BCFG: ${{ matrix.configuration }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-20.04, ubuntu-18.04, ubuntu-16.04]
|
||||
cmp: [gcc, clang]
|
||||
configuration: [default, static, debug, static-debug]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Prepare and compile dependencies
|
||||
run: python cue.py prepare
|
||||
- name: Build main module
|
||||
run: python cue.py build
|
||||
- name: Run main module tests
|
||||
run: python cue.py test
|
||||
- name: Collect and show test results
|
||||
run: python cue.py test-results
|
||||
|
||||
build-macos:
|
||||
name: ${{ matrix.cmp }} / ${{ matrix.configuration }} / ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
# Set environment variables from matrix parameters
|
||||
env:
|
||||
CMP: ${{ matrix.cmp }}
|
||||
BCFG: ${{ matrix.configuration }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [macos-10.15]
|
||||
cmp: [clang]
|
||||
# No static builds on MacOS
|
||||
configuration: [default, debug]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Prepare and compile dependencies
|
||||
run: python cue.py prepare
|
||||
- name: Build main module
|
||||
run: python cue.py build
|
||||
- name: Run main module tests
|
||||
run: python cue.py test
|
||||
- name: Collect and show test results
|
||||
run: python cue.py test-results
|
||||
|
||||
build-windows:
|
||||
name: ${{ matrix.cmp }} / ${{ matrix.configuration }} / ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
env:
|
||||
CMP: ${{ matrix.cmp }}
|
||||
BCFG: ${{ matrix.configuration }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [windows-2019, windows-2016]
|
||||
cmp: [gcc, vs2019, vs2017]
|
||||
configuration: [default, static, debug, static-debug]
|
||||
# Available: vs2017/windows-2016 and vs2019/windows-2019
|
||||
exclude:
|
||||
- os: windows-2019
|
||||
cmp: vs2017
|
||||
- os: windows-2016
|
||||
cmp: vs2019
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Prepare and compile dependencies
|
||||
run: python cue.py prepare
|
||||
- name: Build main module
|
||||
run: python cue.py build
|
||||
- name: Run main module tests
|
||||
run: python cue.py test
|
||||
- name: Collect and show test results
|
||||
run: python cue.py test-results
|
||||
|
||||
# Same setup and toolchain as on Travis.
|
||||
# Needs Base >= 3.15 to compile, EPICS 7 to also run the tests on qemu
|
||||
build-rtems:
|
||||
name: RTEMS${{ matrix.rtems }} / ${{ matrix.configuration }} / ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
env:
|
||||
CMP: ${{ matrix.cmp }}
|
||||
BCFG: ${{ matrix.configuration }}
|
||||
RTEMS: ${{ matrix.rtems }}
|
||||
APT: re2c g++-mingw-w64-i686 g++-mingw-w64-x86-64 qemu-system-x86
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-18.04]
|
||||
cmp: [gcc]
|
||||
configuration: [default, static, debug, static-debug]
|
||||
rtems: ["4.9", "4.10"]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Prepare and compile dependencies
|
||||
run: python cue.py prepare
|
||||
- name: Build main module
|
||||
run: python cue.py build
|
||||
- name: Run main module tests
|
||||
run: python cue.py test
|
||||
- name: Collect and show test results
|
||||
run: python cue.py test-results
|
||||
|
||||
# The WINE cross builds are of somewhat limited use,
|
||||
# as there are native gcc/MinGW builds available on GitHub Actions
|
||||
build-wine:
|
||||
name: WINE${{ matrix.wine }} / ${{ matrix.configuration }} / ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
env:
|
||||
CMP: ${{ matrix.cmp }}
|
||||
BCFG: ${{ matrix.configuration }}
|
||||
WINE: ${{ matrix.wine }}
|
||||
APT: re2c g++-mingw-w64-i686 g++-mingw-w64-x86-64
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-18.04]
|
||||
cmp: [gcc]
|
||||
configuration: [default, static, debug, static-debug]
|
||||
wine: [32, 64]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Prepare and compile dependencies
|
||||
run: python cue.py prepare
|
||||
- name: Build main module
|
||||
run: python cue.py build
|
||||
- name: Run main module tests
|
||||
run: python cue.py test
|
||||
- name: Collect and show test results
|
||||
run: python cue.py test-results
|
||||
43
github-actions/ci-scripts-build.yml.example-mini
Normal file
43
github-actions/ci-scripts-build.yml.example-mini
Normal file
@@ -0,0 +1,43 @@
|
||||
# .github/workflows/ci-scripts-build.yml for use with EPICS Base ci-scripts
|
||||
# (see: https://github.com/epics-base/ci-scripts)
|
||||
|
||||
# This is YAML - indentation levels are crucial
|
||||
|
||||
# Set the 'name:' properties to values that work for you
|
||||
|
||||
name: MYMODULE ci-scripts build
|
||||
|
||||
# Trigger on pushes and PRs to any branch
|
||||
on: [push, pull_request]
|
||||
|
||||
env:
|
||||
SETUP_PATH: .ci-local:.ci
|
||||
SET: test01
|
||||
CMP: gcc
|
||||
|
||||
jobs:
|
||||
build-linux:
|
||||
name: ${{ matrix.base }} / ${{ matrix.cmp }} / ${{ matrix.configuration }} / ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
# Set environment variables from matrix parameters
|
||||
env:
|
||||
CMP: ${{ matrix.cmp }}
|
||||
BCFG: ${{ matrix.configuration }}
|
||||
BASE: ${{ matrix.base }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-20.04, ubuntu-18.04]
|
||||
cmp: [gcc]
|
||||
configuration: [default, static]
|
||||
base: ["7.0", "3.15"]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Prepare and compile dependencies
|
||||
run: python cue.py prepare
|
||||
- name: Build main module
|
||||
run: python cue.py build
|
||||
- name: Run main module tests
|
||||
run: python cue.py test
|
||||
- name: Collect and show test results
|
||||
run: python cue.py test-results
|
||||
Reference in New Issue
Block a user