https://github.com/spack/github-actions-buildcache
Spack build cache for Github Actions
https://github.com/spack/github-actions-buildcache
Last synced: about 1 year ago
JSON representation
Spack build cache for Github Actions
- Host: GitHub
- URL: https://github.com/spack/github-actions-buildcache
- Owner: spack
- License: other
- Created: 2023-11-02T07:58:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T08:59:47.000Z (over 1 year ago)
- Last Synced: 2025-03-02T06:47:39.581Z (about 1 year ago)
- Homepage:
- Size: 45.9 KB
- Stars: 7
- Watchers: 7
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Spack buildcache for GitHub Actions
This repo provides a buildcache to speed up Spack in your GitHub Actions.
Currently it provides binaries from Spack `develop` for
- `%gcc@9 ^glibc@2.31 target=x86_64_v3`
- `%clang@12 ^glibc@2.31 target=x86_64_v3`
which are compatible with
- Ubuntu 20.04 and later
- Debian 11 and later
- RHEL 9 and later
- Fedora 32 and later
To use it, add an environment `spack.yaml` to the root of your own repository
```yaml
spack:
view: my_view
specs:
- python@3.11
config:
install_tree:
root: /opt/spack
packages:
all:
require: 'target=x86_64_v3'
```
and Spack install it in a GitHub Action:
```yaml
name: Build
on: push
jobs:
example:
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Spack
uses: spack/setup-spack@v2
- name: Concretize
run: spack -e . concretize
- name: Install
run: spack -e . install
- name: Run
run: ./my_view/bin/python3 -c 'print("hello world")'
```
## Caching your own binaries
If you want to cache your own binaries too, there are three steps to take:
1. Use padding in the install root, and add an additional mirror to `spack.yaml`:
```yaml
spack:
config:
install_tree:
root: /opt/spack
padded_length: 128
mirrors:
local-buildcache:
url: oci://ghcr.io//spack-buildcache
signed: false
access_pair:
id_variable: GITHUB_USER
secret_variable: GITHUB_TOKEN
```
2. Configure the permissions for `GITHUB_TOKEN`:
```yaml
jobs:
example:
runs-on: ubuntu-22.04
permissions:
packages: write
```
3. Add an extra job step that pushes installed Spack packages to the local
buildcache:
```yaml
jobs:
example:
steps:
- name: Push packages and update index
env:
GITHUB_USER: ${{ github.actor }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: spack -e . buildcache push --base-image ubuntu:22.04 --update-index local-buildcache
if: ${{ !cancelled() }}
```
NOTE: Make sure to add `if: ${{ !cancelled() }}`, so that binaries for successfully
installed packages are available also when a dependent fails to build.
### Caching your own binaries in *private* repos and buildcaches
When your local buildcache is stored in a private GitHub package,
you need to specify the OCI credentials already *before* `spack concretize`.
This is because Spack needs to fetch the buildcache index.
```yaml
env:
GITHUB_USER: ${{ github.actor }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
jobs:
example-private:
steps:
- name: Concretize
run: spack -e . concretize
- name: Install
run: spack -e . install
- name: Push packages and update index
run: spack -e . buildcache push --base-image ubuntu:22.04 --update-index local-buildcache
```
From a security perspective, do note that the `GITHUB_TOKEN` is exposed to every
job step.
## Contributing
If you want to make more packages available, contribute to
[spack.yaml](spack.yaml).
## Build strategy
Since compiling software in GitHub actions is relatively slow, this stack is
built using `concretizer:reuse:dependencies`. That means that the latest
versions of the packages listed in [spack.yaml](spack.yaml) are built, but
their dependencies are only updated when a package compatibility rule requires
it. The stack is currently built on demand, not on a schdule.
## License
This project is part of Spack. Spack is distributed under the terms of both the
MIT license and the Apache License (Version 2.0). Users may choose either
license, at their option.
All new contributions must be made under both the MIT and Apache-2.0 licenses.
See LICENSE-MIT, LICENSE-APACHE, COPYRIGHT, and NOTICE for details.
SPDX-License-Identifier: (Apache-2.0 OR MIT)
LLNL-CODE-811652