YosysHQ / setup-oss-cad-suite

Set up your GitHub Actions workflow with a OSS CAD Suite

Setup-OSS-CAD-Suite

This downloads and sets up a pre-build EDA environment from OSS CAD Suite, allowing you to have all the most up-to-date tools available to you.

Usage

The following examples show the basic usage for this action.

Set up the latest release of the tools

This sets up the latest nightly build of the oss-cad-suite tools and adds them to your path.

steps:
- uses: actions/checkout@v4
- uses: YosysHQ/setup-oss-cad-suite@v3
- run: yosys --version

Set up a specific release of the tools

This sets up a specified build of the oss-cad-suite tools and adds them to your path.

steps:
- uses: actions/checkout@v4
- uses: YosysHQ/setup-oss-cad-suite@v3
  with:
    version: '2021-05-28'
- run: yosys --version

HINT: This can be combined with the @actions/cache action to cache the download to speed up subsequent CI runs.

Use GITHUB_TOKEN to prevent API rate limiting

Sometimes the action will fail due to the workers IP hitting the public API rate limit. With this the action will authenticate to the API with the token to allow you to hopefully eliminate the flakiness that would occur due to this.

steps:
- uses: actions/checkout@v4
- uses: YosysHQ/setup-oss-cad-suite@v3
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
- run: yosys --version

Note The action will not write to the API using the token, the only time the token is used is when reading the releases API endpoint for oss-cad-suite builds

Use bundled python3 environment

You can override the systems python environment with the one bundled with oss-cad-suite as follows:

steps:
- uses: actions/checkout@v4
- uses: YosysHQ/setup-oss-cad-suite@v3
  with:
    python-override: true
- run: yosys --version

Example

name: CI
on:
  workflow_dispatch:
jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: YosysHQ/setup-oss-cad-suite@v3
      - run: yosys --version

License

The scripts and documentation in this project are released under the ISC