ci: use GitHub Packages to avoid installing the toolchain from scratc…

…h in each job

INSTALL_DIR changed to an absolute location due to actions/runner#1525

Signed-off-by: Unai Martinez-Corral <[email protected]>

.github/scripts/generate_matrices.py

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+
+from sys import argv as sys_argv
+
+registry = 'ghcr.io/umarcor/symbiflow/conda'
+
+isFork = len(sys_argv)>1 and sys_argv[1] != 'SymbiFlow/symbiflow-examples'
+
+runs_on = (
+    'ubuntu-latest'
+    if isFork else
+    ['self-hosted', 'Linux', 'X64']
+)
+
+examples = [
+    "picosoc",
+    "litex",
+    "litex_linux",
+    "button_controller",
+    "pulse_width_led",
+    "timer",
+    "hello-a",
+    "hello-b",
+    "hello-c",
+    "hello-d",
+    "hello-e",
+    "hello-f",
+    "hello-g",
+    "hello-h",
+    "hello-i",
+    "hello-j",
+    "hello-k",
+    "hello-l"
+]
+
+jobs = []
+
+osvers = [
+    ("ubuntu", "focal"),
+    ("centos", "8"),
+    ("debian", "buster"),
+    ("debian", "bullseye"),
+    ("debian", "sid"),
+    ("fedora", "35")
+]
+
+if not isFork:
+    examples = [
+        "counter",
+        "litex_sata",
+    ] + examples
+    osvers += [
+        ("ubuntu", "xenial"),
+        ("ubuntu", "bionic"),
+        ("centos", "7"),
+    ]
+
+for osver in osvers:
+    jobs += [{
+        'runs-on': runs_on,
+        'fpga-fam': "xc7",
+        'image': f'{registry}/{osver[0]}/{osver[1]}/xc7',
+        'example': example,
+        'name': f'xc7 | {osver[0]}/{osver[1]} | {example}'
+    } for example in examples]
+
+jobs += [{
+    'runs-on': runs_on,
+    'fpga-fam': "eos-s3",
+    'image': f'{registry}/{osver[0]}/{osver[1]}/eos-s3',
+    'example': "counter",
+    'name': f'eos-s3 | {osver[0]}/{osver[1]} | counter',
+} for osver in osvers]
+
+print('::set-output name=matrix::' + str(jobs))
+
+utils = {
+    'ubuntu': 'apt -qqy update && apt -qqy install git wget locales && locale-gen $LANG',
+    'debian': 'apt -qqy update && apt -qqy install git wget locales && locale-gen $LANG',
+    'centos': 'yum -y install git wget',
+    'fedora': 'dnf install -y git wget',
+}
+
+# FIXME:
+# On centos:8 the following needs to be executed before installing the utils.
+# sed -i 's/mirrorlist/#mirrorlist/g' /etc/yum.repos.d/CentOS-*
+# sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g' /etc/yum.repos.d/CentOS-*
+
+images = [
+    {
+        'registry': f'{registry}',
+        'image': f'{osver[0]}/{osver[1]}/{fam}',
+        'from': f'{osver[0]}:{osver[1]}',
+        'utils': utils[osver[0]],
+        'args': f'{fam} {osver[0]}'
+    } for osver in osvers for fam in ['xc7', 'eos-s3']
+]
+
+print('::set-output name=images::' + str(images))

.github/workflows/sphinx-tuttest.yml

@@ -13,65 +13,89 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       matrix: ${{ steps.generate.outputs.matrix }}
+      images: ${{ steps.generate.outputs.images }}
 
     steps:
 
       - name: Setup repository
         uses: actions/checkout@v2
 
-      - name: Generate examples matrix
+      - name: Generate matrices
         id: generate
-        run: ./.github/scripts/generate_job_matrix.py '${{ github.repository }}'
+        run: ./.github/scripts/generate_matrices.py '${{ github.repository }}'
 
 
-  Test:
+  Packages:
     needs: Matrix
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include: ${{ fromJson(needs.Matrix.outputs.images) }}
+    name: 'Image: ${{ matrix.image }}'
+    env:
+      DOCKER_BUILDKIT: 1
+
+    steps:
+
+    - name: Setup repository
+      uses: actions/checkout@v2
+      with:
+        submodules: recursive
+
+    - name: Build container image
+      run: |
+        docker build -t ${{ matrix.registry }}/${{ matrix.image }} . -f- <<'EOF'
+        FROM ${{ matrix.from }}
+
+        ENV LANG en_US.UTF-8
+
+        # Install utils
+        RUN ${{ matrix.utils }}
+
+        # Install tuttest
+        RUN wget https://github.com/antmicro/tuttest/releases/download/v0.2-beta/tuttest -O /usr/bin/tuttest \
+         && chmod a+rx /usr/bin/tuttest
+
+        # Install SymbiFlow toolchain
+        RUN --mount=type=bind,target=/tmp/ctx cp -vr /tmp/ctx /tmp/repo \
+         && cd /tmp/repo && bash /tmp/repo/.github/scripts/install-toolchain.sh ${{ matrix.args }} \
+         && cd .. && rm -rf /tmp/repo
+        EOF
+
+    - name: Push container image
+      uses: pyTooling/Actions/with-post-step@r0
+      with:
+        main: |
+          echo '${{ github.token }}' | docker login ghcr.io -u GitHub-Actions --password-stdin
+          docker push ${{ matrix.registry }}/${{ matrix.image }}
+        post: docker logout ghcr.io
+
+
+  Test:
+    needs:
+      - Matrix
+      - Packages
     strategy:
       fail-fast: false
       matrix:
         include: ${{ fromJson(needs.Matrix.outputs.matrix) }}
     runs-on: ${{ matrix.runs-on }}
-    name: ${{ matrix.fpga-fam }} | ${{ matrix.os }} ${{ matrix.os-version }} | ${{ matrix.example }}
+    name: ${{ matrix.name }}
 
     env:
-      LANG: "en_US.UTF-8"
       DEBIAN_FRONTEND: "noninteractive"
       GHA_PREEMPTIBLE: "false"
 
-    container: ${{matrix.os}}:${{matrix.os-version}}
+    container: ${{matrix.image}}
 
     steps:
-      - name: Install utils
-        if: ${{matrix.os == 'ubuntu' || matrix.os == 'debian'}}
-        run: apt -qqy update && apt -qqy install git wget locales && locale-gen $LANG
-
-      - name: Install utils
-        if: ${{matrix.os == 'centos' && matrix.os-version == '8'}}
-        run: |
-          sed -i 's/mirrorlist/#mirrorlist/g' /etc/yum.repos.d/CentOS-*
-          sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g' /etc/yum.repos.d/CentOS-*
-
-      - name: Install utils
-        if: ${{matrix.os == 'centos'}}
-        run: yum -y install git wget
-
-      - name: Install utils
-        if: ${{matrix.os == 'fedora'}}
-        run: dnf install -y git wget
 
       - name: Setup repository
         uses: actions/checkout@v2
         with:
           submodules: recursive
 
-      - name: Install tuttest
-        run: |
-          wget https://github.com/antmicro/tuttest/releases/download/v0.2-beta/tuttest -O /usr/bin/tuttest
-          chmod a+rx /usr/bin/tuttest
-
-      - name: Install SymbiFlow toolchain
-        run: bash .github/scripts/install-toolchain.sh ${{matrix.fpga-fam}} ${{matrix.os}}
-
       - name: Build examples
         run: bash .github/scripts/build-examples.sh ${{matrix.fpga-fam}} ${{matrix.example}}
 

docs/building-examples.rst

@@ -8,7 +8,7 @@ set it to earlier, for example:
 .. code-block:: bash
    :name: export-install-dir
 
-   export INSTALL_DIR=~/opt/symbiflow
+   export INSTALL_DIR=/opt/symbiflow
 
 Select your FPGA family:
 
@@ -100,7 +100,7 @@ Enter the directory that contains examples for Xilinx 7-Series FPGAs:
    :file: templates/example.jinja
 
 .. jinja:: xc7_pulse_width_led
-   :file: templates/example.jinja 
+   :file: templates/example.jinja
 
 
 

docs/getting-symbiflow.rst

@@ -82,7 +82,7 @@ and so you will need to add some ``sudo`` commands to the instructions below.
 .. code-block:: bash
    :name: conda-install-dir
 
-   export INSTALL_DIR=~/opt/symbiflow
+   export INSTALL_DIR=/opt/symbiflow
 
 Toolchain
 ~~~~~~~~~