Skip to content

add handling for clean vs cleanFull, update capitalization of some names #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mr-git merged 1 commit into from
Aug 10, 2026
Merged

add handling for clean vs cleanFull, update capitalization of some names #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ on:
detected from project/build.properties.
type: string
default: ''
clean_task:
description: >-
sbt task that cleans the working directory. Defaults to `cleanFull` on sbt 2 and
`clean` on sbt 1, detected from project/build.properties.
type: string
default: ''
coverage:
description: 'Collect test coverage and upload it to Coveralls'
type: boolean
Expand All @@ -34,7 +40,7 @@ on:
type: boolean
default: true
doc_check:
description: 'Check that scaladoc builds'
description: 'Check that Scaladoc builds'
type: boolean
default: true
sonar:
Expand Down Expand Up @@ -95,7 +101,7 @@ jobs:
disk-cache: ${{ !inputs.coverage }}

- name: resolve test task
id: tasks
id: test-task
env:
TEST_TASK: ${{ inputs.test_task }}
run: |
Expand All @@ -108,15 +114,29 @@ jobs:
echo "test=test" >> "$GITHUB_OUTPUT"
fi

- name: resolve clean task
id: clean-task
env:
CLEAN_TASK: ${{ inputs.clean_task }}
run: |
if [[ -n "$CLEAN_TASK" ]]; then
echo "clean=$CLEAN_TASK" >> "$GITHUB_OUTPUT"
elif grep -qE '^sbt\.version\s*=\s*2\.' project/build.properties; then
# in sbt 2 the `clean` doesn't remove all generated classes
echo "clean=cleanFull" >> "$GITHUB_OUTPUT"
else
echo "clean=clean" >> "$GITHUB_OUTPUT"
fi

# The coverage build runs before any other compile: scoverage's instrumentation is not part of
# sbt's compile cache key, so a plain compile done first would be reused here and the coverage
# report would come out empty.
- name: build ${{ matrix.scala }}
run: |
if [[ "${{ inputs.coverage }}" == "true" ]]; then
sbt "++${{ matrix.scala }}; clean; coverage; ${{ steps.tasks.outputs.test }}; coverageAggregate"
sbt "++${{ matrix.scala }}; ${{ steps.clean-task.outputs.clean }}; coverage; ${{ steps.test-task.outputs.test }}; coverageAggregate"
else
sbt "++${{ matrix.scala }}; clean; ${{ steps.tasks.outputs.test }}"
sbt "++${{ matrix.scala }}; ${{ steps.clean-task.outputs.clean }}; ${{ steps.test-task.outputs.test }}"
fi

- name: locate coverage report
Expand Down
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Scala CI workflow

Runs tests, coverage, binary compatibility, formatting and scaladoc on every push and pull request.
Replaces the hand-written `ci.yml` that each project used to carry.
Runs tests, coverage, binary compatibility, formatting and Scaladoc on every push and pull request.
Replaces the handwritten `ci.yml` that each project used to carry.

### Setup

Expand Down Expand Up @@ -42,19 +42,19 @@ alternatives and drops the security rating to C:

### Inputs

| input | default | notes |
|---|---|---|
| `scala_versions` | `'["2.13.18", "3.3.8"]'` | JSON array; becomes the build matrix |
| `java_version` | `'17'` | |
| `java_distribution` | `'temurin'` | |
| `test_task` | auto | `testFull` on sbt 2, `test` on sbt 1, read from `project/build.properties` |
| `coverage` | `true` | collect coverage and upload to Coveralls |
| `version_policy_check` | `true` | requires [sbt-version-policy](https://github.com/scalacenter/sbt-version-policy/) |
| `scalafmt_check` | `true` | |
| `doc_check` | `true` | runs `Compile/doc` |
| `sonar` | `false` | run a SonarQube Cloud scan, see below |
| `sonar_project_key` | `<owner>_<repo>` | |
| `sonar_args` | `''` | extra `-D` arguments for the scanner |
| input | default | notes |
|------------------------|--------------------------|-----------------------------------------------------------------------------------|
| `scala_versions` | `'["2.13.18", "3.3.8"]'` | JSON array; becomes the build matrix |
| `java_version` | `'17'` | |
| `java_distribution` | `'temurin'` | |
| `test_task` | auto | `testFull` on sbt 2, `test` on sbt 1, read from `project/build.properties` |
| `coverage` | `true` | collect coverage and upload to Coveralls |
| `version_policy_check` | `true` | requires [sbt-version-policy](https://github.com/scalacenter/sbt-version-policy/) |
| `scalafmt_check` | `true` | |
| `doc_check` | `true` | runs `Compile/doc` |
| `sonar` | `false` | run a SonarQube Cloud scan, see below |
| `sonar_project_key` | `<owner>_<repo>` | |
| `sonar_args` | `''` | extra `-D` arguments for the scanner |

Example for a project without `sbt-version-policy` and on a different Scala set:

Expand All @@ -78,10 +78,10 @@ Two sbt 2 behaviours make a naive coverage setup report nothing while still pass
on any run whose build files did not change. This workflow sets `disk-cache: false` whenever
coverage is enabled.

The workflow also fails if the produced cobertura report has no valid lines, so a silently empty
The workflow also fails if the produced Cobertura report has no valid lines, so a silently empty
report is an error rather than a green build.

Binary compatibility, formatting and scaladoc run as **explicit sbt tasks**, not via a project-local
Binary compatibility, formatting and Scaladoc run as **explicit sbt tasks**, not via a project-local
`check` alias. An alias can be stubbed out (`addCommandAlias("check", "show version")`), which makes
the gate silently guarantee nothing.

Expand Down