Skip to content

oneapi-src/oneapi-ci

Repository files navigation

Intel® oneAPI CI Samples

REUSE status OpenSSF Best Practices

This repository contains sample Public/Cloud CI configurations that demonstrate installing Intel® oneAPI toolkit components and building applications. You may also find this repository useful for automating the install process on your own systems. The following configurations are supported:

Compilers icc, icx, icpx, dpcpp, ifort, ifx
OS platforms Linux, Windows, MacOS
Install methods Intel installer, apt, dnf, docker container, CI cache

The config files are intended to be samples that demonstrate a wide variety of use cases. For your own use, select the parts that you need. You may also want to customize the set of compilers and libraries that are installed. See component listings for the component names to use in the scripts.

Status

CI Config Status
GitHub Actions .github/workflows/build_all.yml Build status
Circle CI .circleci/config.yml Build status
AppVeyor .appveyor.yml Build status
GitLab CI .gitlab-ci.yml Build status
Azure Pipelines .azure-pipelines.yml Build status

Supported Configurations

C++/Fortran/DPC++ C++/Fortran
CI Linux APT Linux DNF Linux Docker Linux Windows MacOS
GitHub
Circle
AppVeyor
GitLab
Azure
Jenkins

Caching

Some of the oneAPI components are large and can take a few minutes to download install. To accelerate install, we demonstrate the use of caching.

Using oneAPI in Jenkins pipelines

There are multiple ways to add oneAPI tools to a Jenkins pipeline:

  1. setup the tools on Jenkins agent directly, or create custom container with the tools you need

  2. use optimized containers from Intel oneContainer Portal

The Jenkinsfile in this repo demonstrates building DPC++, C++ and Fortran samples in intel/oneapi-hpckit container in Jenkins.

To give it a try:

  1. Follow Jenkins Install Guide to setup Jenkins, or use your existing setup.
  2. Install Docker and Docker Pipeline plugins.
  3. Create new pipeline for this repository using New Item -> Pipeline.
  4. Build the pipeline.
  5. The result will look like this in Blue Ocean.

Jenkins Pipeline Example

See also

Enabling Performance Profiling in GitLab* CI

Troubleshooting

Detailed install logs are saved as artifacts in most CI jobs. Those logs can be helpful in case of installation issues.

License

The contents of this repository follows the SPDX standard for documenting license information. The Intel oneAPI compilers and libraries are distributed separately. They are free to use and are governed by the oneAPI EULA.

Contribute

See contributing.

Security

See security guidelines.