ci: avoid installing the toolchain from scratch in each job

* Use GitHub Packages * Use container in a step, instead of a container job INSTALL_DIR changed to an absolute location due to actions/runner#1525 Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
chipsalliance · May 16, 2022 · 723a474 · 723a474
1 parent 46e7584
commit 723a474
Show file tree

Hide file tree

Showing 4 changed files with 94 additions and 37 deletions.
diff --git a/.github/scripts/generate_job_matrix.py → .github/scripts/generate_matrices.py b/.github/scripts/generate_job_matrix.py → .github/scripts/generate_matrices.py
@@ -18,6 +18,8 @@
 
 from sys import argv as sys_argv
 
+registry = 'ghcr.io/chipsalliance/f4pga/dev/conda'
+
 isFork = len(sys_argv)>1 and sys_argv[1] != 'chipsalliance/f4pga-examples'
 usesSurelog = len(sys_argv)>2 and sys_argv[2] == 'Surelog'
 
@@ -85,19 +87,36 @@
     jobs += [{
         'runs-on': runs_on,
         'fpga-fam': "xc7",
-        'os': osver[0],
-        'os-version': osver[1],
-        'example': example
+        '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",
-    'os': osver[0],
-    'os-version': osver[1],
-    'example': "counter"
+    '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(f'::set-output name=matrix::{jobs!s}')
+print('::set-output name=matrix::' + str(jobs))
+
+utils = {
+    'ubuntu': 'apt -qqy update && apt -qqy install wget locales && locale-gen $LANG',
+    'debian': 'apt -qqy update && apt -qqy install wget locales && locale-gen $LANG',
+    'centos': 'yum -y install wget',
+    'fedora': 'dnf install -y wget'
+}
+
+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(str(jobs))
+print('::set-output name=images::' + str(images))
diff --git a/.github/workflows/sphinx-tuttest.yml b/.github/workflows/sphinx-tuttest.yml
@@ -10,29 +10,78 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       matrix: ${{ steps.generate.outputs.matrix }}
+      images: ${{ steps.generate.outputs.images }}
 
     steps:
 
       - name: Setup repository
         uses: actions/checkout@v3
 
-      - 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 F4PGA 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
+      if: ${{ github.event_name != 'pull_request' }}
+      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"
       SURELOG_CMD: ""
 
@@ -104,36 +153,25 @@ jobs:
       GHA_PREEMPTIBLE: "false"
       SURELOG_CMD: "-parse -DSYNTHESIS"
 
-    container: ${{matrix.os}}:${{matrix.os-version}}
-
     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'}}
-        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@v3
         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 F4PGA toolchain
-        run: bash .github/scripts/install-toolchain.sh ${{matrix.fpga-fam}} ${{matrix.os}}
+      - name: Pull container image
+        run: docker pull ${{matrix.image}}
 
       - name: Build examples
-        run: bash .github/scripts/build-examples.sh ${{matrix.fpga-fam}} ${{matrix.example}}
+        # Workaround for 'uses: docker://${{matrix.image}}' not being supported.
+        # See https://github.com/github/feedback/discussions/9049
+        run: >-
+          docker run --rm
+          -v $(pwd):/wrk -w /wrk
+          -e DEBIAN_FRONTEND="noninteractive"
+          ${{matrix.image}}
+          bash .github/scripts/build-examples.sh ${{matrix.fpga-fam}} ${{matrix.example}}
 
       - uses: actions/upload-artifact@v3
         with:

diff --git a/docs/building-examples.rst b/docs/building-examples.rst
@@ -9,7 +9,7 @@ set it to earlier, for example:
 .. code-block:: bash
    :name: export-install-dir
 
-   export INSTALL_DIR=~/opt/f4pga
+   export INSTALL_DIR=/opt/f4pga
 
 Select your FPGA family:
 

diff --git a/docs/getting.rst b/docs/getting.rst
@@ -84,7 +84,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/f4pga
+   export INSTALL_DIR=/opt/f4pga
 
 Setup and download assets
 ~~~~~~~~~~~~~~~~~~~~~~~~~