Skip to content

Commit

Permalink
[ci] Split formatting and docs checks into separate task (backport #2749
Browse files Browse the repository at this point in the history
) (#2750)

* [ci] Split formatting and docs checks into separate task (#2749)

(cherry picked from commit ed26942)

# Conflicts:
#	.github/workflows/test.yml

* Resolve backport conflicts

Co-authored-by: Jack Koenig <koenig@sifive.com>
  • Loading branch information
mergify[bot] and jackkoenig authored Sep 27, 2022
1 parent f195568 commit 9f1eae1
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,6 @@ jobs:
java-version: ${{ matrix.jvm }}
- name: Cache Scala
uses: coursier/cache-action@v5
- name: Check Formatting (Scala 2.12 only)
if: startsWith(matrix.scala, '2.12')
run: sbt ++${{ matrix.scala }} scalafmtCheckAll
- name: Documentation (Scala 2.12 only)
if: startsWith(matrix.scala, '2.12')
run: sbt ++${{ matrix.scala }} docs/mdoc unidoc
- name: Use Treadle for Pull Requests
if: github.event_name == 'pull_request'
run: echo "CHISEL3_CI_USE_TREADLE=1" >> $GITHUB_ENV
Expand All @@ -58,6 +52,23 @@ jobs:
- name: Binary compatibility
run: sbt ++${{ matrix.scala }} mimaReportBinaryIssues

doc:
name: Formatting and Documentation
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Scala
uses: olafurpg/setup-scala@v10
with:
java-version: "adopt@1.11"
- name: Cache Scala
uses: coursier/cache-action@v5
- name: Check Formatting
run: sbt scalafmtCheckAll
- name: Documentation
run: sbt docs/mdoc unidoc

integration:
name: Integration Tests (w/ chiseltest)
runs-on: ubuntu-20.04
Expand Down Expand Up @@ -90,7 +101,7 @@ jobs:
# When adding new jobs, please add them to `needs` below
check-tests:
name: "check tests"
needs: [ci, integration]
needs: [ci, integration, doc]
runs-on: ubuntu-20.04
if: success() # only run if all tests have passed
outputs:
Expand Down

0 comments on commit 9f1eae1

Please sign in to comment.