Document CursorEffectContainer and update outdated name
#6682
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| on: [push, pull_request] | |
| name: Continuous Integration | |
| jobs: | |
| inspect-code: | |
| name: Code Quality | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install .NET 8.0.x | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| dotnet-version: "8.0.x" | |
| - name: Restore Tools | |
| run: dotnet tool restore | |
| - name: Restore Packages | |
| run: dotnet restore osu-framework.Desktop.slnf | |
| - name: Restore inspectcode cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ github.workspace }}/inspectcode | |
| key: inspectcode-${{ hashFiles('.config/dotnet-tools.json', '.github/workflows/ci.yml', 'osu-framework.sln*', 'osu-framework*.slnf', '.editorconfig', '.globalconfig', 'CodeAnalysis/*', '**/*.csproj', '**/*.props') }} | |
| - name: Dotnet code style | |
| run: dotnet build -c Debug -warnaserror osu-framework.Desktop.slnf -p:EnforceCodeStyleInBuild=true | |
| - name: CodeFileSanity | |
| run: | | |
| # TODO: Add ignore filters and GitHub Workflow Command Reporting in CFS. That way we don't have to do this workaround. | |
| # FIXME: Suppress warnings from templates project | |
| exit_code=0 | |
| while read -r line; do | |
| if [[ ! -z "$line" && "$line" != *"/osu.Framework.Templates/"* ]]; then | |
| echo "::error::$line" | |
| exit_code=1 | |
| fi | |
| done <<< $(dotnet codefilesanity) | |
| exit $exit_code | |
| - name: InspectCode | |
| run: dotnet jb inspectcode $(pwd)/osu-framework.Desktop.slnf --no-build --output="inspectcodereport.xml" --caches-home="inspectcode" --verbosity=WARN | |
| - name: NVika | |
| run: dotnet nvika parsereport "${{github.workspace}}/inspectcodereport.xml" --treatwarningsaserrors | |
| test: | |
| name: Test | |
| runs-on: ${{matrix.os.fullname}} | |
| env: | |
| OSU_EXECUTION_MODE: ${{matrix.threadingMode}} | |
| OSU_TESTS_LOCAL_HTTPBIN: 1 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - { prettyname: Windows, fullname: windows-latest, configuration: Debug } | |
| - { prettyname: macOS, fullname: macos-latest, configuration: Debug } | |
| - { prettyname: Linux, fullname: ubuntu-latest, configuration: Debug } | |
| - { prettyname: Linux, fullname: ubuntu-latest, configuration: Release } | |
| threadingMode: ['SingleThread', 'MultiThreaded'] | |
| timeout-minutes: 60 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install .NET 8.0.x | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| dotnet-version: "8.0.x" | |
| - name: Setup Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: 1.21.9 | |
| - name: Install httpbin | |
| run: go install github.com/mccutchen/go-httpbin/v2/cmd/go-httpbin@latest | |
| - name: Run httpbin | |
| run: $HOME/go/bin/go-httpbin & | |
| shell: bash | |
| - name: Compile | |
| run: dotnet build -c ${{matrix.os.configuration}} -warnaserror osu-framework.Desktop.slnf | |
| - name: Test | |
| run: dotnet test $pwd/**/*.Tests/bin/${{matrix.os.configuration}}/*/*.Tests.dll --no-build --logger "trx;LogFileName=TestResults-${{matrix.os.prettyname}}-${{matrix.threadingMode}}-${{matrix.os.configuration}}.trx" -- NUnit.ConsoleOut=0 | |
| shell: pwsh | |
| # Attempt to upload results even if test fails. | |
| # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#always | |
| - name: Upload Test Results | |
| uses: actions/upload-artifact@v4 | |
| if: ${{ always() }} | |
| with: | |
| name: osu-framework-test-results-${{matrix.os.prettyname}}-${{matrix.threadingMode}}-${{matrix.os.configuration}} | |
| path: ${{github.workspace}}/TestResults/TestResults-${{matrix.os.prettyname}}-${{matrix.threadingMode}}-${{matrix.os.configuration}}.trx | |
| build-only-android: | |
| name: Build only (Android) | |
| runs-on: windows-latest | |
| timeout-minutes: 60 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup JDK 11 | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: microsoft | |
| java-version: 11 | |
| - name: Install .NET 8.0.x | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| dotnet-version: "8.0.x" | |
| - name: Restore .NET workloads | |
| # since windows image 20241113.3.0, not specifying a version here | |
| # installs the .NET 7 version of android workload for very unknown reasons. | |
| # revisit once we upgrade to .NET 9, it's probably fixed there. | |
| run: dotnet workload install android --version (dotnet --version) | |
| - name: Compile | |
| run: dotnet build -c Debug osu-framework.Android.slnf | |
| build-only-ios: | |
| name: Build only (iOS) | |
| runs-on: macos-latest | |
| timeout-minutes: 60 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install .NET 8.0.x | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| dotnet-version: "8.0.x" | |
| - name: Restore .NET workloads | |
| run: dotnet workload install ios --from-rollback-file workloads.json | |
| - name: Compile | |
| run: dotnet build -c Debug osu-framework.iOS.slnf | |