Skip to content

Continuous Integration #498

Continuous Integration

Continuous Integration #498

Workflow file for this run

name: Continuous Integration
on:
workflow_dispatch:
pull_request:
branches-ignore:
- ci/ci-circt-nightly
push:
tags:
- '*'
branches:
- main
- '*.x'
env:
circt: "version-file"
jobs:
set-circt-versions:
name: Set the CIRCT version from the env
runs-on: ubuntu-20.04
steps:
- name: Set CIRCT Version
id: set-circt-version
run: |
echo versions='["${{ env.circt }}"]' >> $GITHUB_OUTPUT
outputs:
circt-versions: ${{ steps.set-circt-version.outputs.versions }}
ci:
name: ci
needs: [set-circt-versions]
strategy:
matrix:
system: ["ubuntu-20.04"]
jvm: [8]
scala: ["2.13.12"]
espresso: ["2.4"]
circt: ${{ fromJSON(needs.set-circt-versions.outputs.circt-versions) }}
uses: ./.github/workflows/test.yml
with:
system: ${{ matrix.system }}
jvm: ${{ matrix.jvm }}
scala: ${{ matrix.scala }}
espresso: ${{ matrix.espresso }}
circt: ${{ matrix.circt }}
# Sentinel job to simplify how we specify which checks need to pass in branch
# protection and in Mergify. This job checks that all matrix jobs were
# successful.
check-tests:
name: "check tests"
needs: ci
runs-on: ubuntu-20.04
outputs:
success: ${{ steps.setoutput.outputs.success }}
steps:
- id: setoutput
run: echo "success=true" >> $GITHUB_OUTPUT
# Related to check-tests above, this job _always_ runs (even if tests fail
# and thus check-steps is skipped). This two sentinel job approach avoids an
# issue where failing tests causes a single sentinel job to be skipped which
# counts as passing for purposes of branch protection.
#
# See: https://brunoscheufler.com/blog/2022-04-09-the-required-github-status-check-that-wasnt
all_tests_passed:
name: "all tests passed"
runs-on: ubuntu-20.04
if: always() # Always run so that we never skip this check
needs: check-tests
# Pass only if check-tests set its output value
steps:
- run: |
PASSED=${{ needs.check-tests.outputs.success }}
if [[ $PASSED == "true" ]]; then
echo "### All tests passed! :rocket:" >> $GITHUB_STEP_SUMMARY
exit 0
else
echo "### One or more tests FAILED! :bangbang:" >> $GITHUB_STEP_SUMMARY
exit 1
fi
# sbt ci-release publishes all cross versions so this job needs to be
# separate from a Scala versions build matrix to avoid duplicate publishing
publish:
needs: [all_tests_passed]
runs-on: ubuntu-20.04
if: github.event_name == 'push'
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Install CIRCT
uses: seldridge/install-circt@v1.0.0
with:
version: ${{ env.circt }}
github-token: ${{ github.token }}
- name: Setup Scala
uses: actions/setup-java@v3
with:
distribution: 'adopt'
java-version: '8'
cache: 'sbt'
- name: Setup GPG (for Publish)
uses: olafurpg/setup-gpg@v3
- name: Publish
run: sbt ci-release
env:
CI_SNAPSHOT_RELEASE: "+unipublish/publish"
CI_SONATYPE_RELEASE: "+unipublish/publishSigned"
PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
PGP_SECRET: ${{ secrets.PGP_SECRET }}
SONATYPE_PASSWORD: ${{ secrets.CHIPSALLIANCE_SONATYPE_PASSWORD }}
SONATYPE_USERNAME: ${{ secrets.CHIPSALLIANCE_SONATYPE_USERNAME }}
deploy_website:
name: Deploy Website
runs-on: ubuntu-latest
needs: [all_tests_passed]
# Only Deploy website on pushes to main, may change to a stable branch
if: (github.event_name == 'push') && (github.ref_name == 'main')
steps:
- name: Download built website
uses: actions/download-artifact@v3
with:
name: website
- name: Untar built website
run: tar zxf website.tar.gz
- name: Deploy Website to GitHub Pages (From Main Branch)
uses: JamesIves/github-pages-deploy-action@3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: website/docs/target/site