Update README.md #3778
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
| # DSpace Continuous Integration/Build via GitHub Actions | |
| # Concepts borrowed from | |
| # https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-java-with-maven | |
| name: Build | |
| # Run this Build for all pushes / PRs to current branch | |
| on: [push, pull_request] | |
| permissions: | |
| contents: read # to fetch code (actions/checkout) | |
| jobs: | |
| tests: | |
| runs-on: ubuntu-latest | |
| env: | |
| # Give Maven 1GB of memory to work with | |
| MAVEN_OPTS: "-Xmx1024M" | |
| strategy: | |
| # Create a matrix of two separate configurations for Unit vs Integration Tests | |
| # This will ensure those tasks are run in parallel | |
| # Also specify version of Java to use (this can allow us to optionally run tests on multiple JDKs in future) | |
| matrix: | |
| include: | |
| # NOTE: Unit Tests include a retry for occasionally failing tests | |
| # - surefire.rerunFailingTestsCount => try again for flakey tests, and keep track of/report on number of retries | |
| - type: "Unit Tests" | |
| java: 17 | |
| mvnflags: "-DskipUnitTests=false -Dsurefire.rerunFailingTestsCount=2" | |
| resultsdir: "**/target/surefire-reports/**" | |
| # NOTE: ITs skip all code validation checks, as they are already done by Unit Test job. | |
| # - enforcer.skip => Skip maven-enforcer-plugin rules | |
| # - checkstyle.skip => Skip all checkstyle checks by maven-checkstyle-plugin | |
| # - license.skip => Skip all license header checks by license-maven-plugin | |
| # - xml.skip => Skip all XML/XSLT validation by xml-maven-plugin | |
| # - failsafe.rerunFailingTestsCount => try again for flakey tests, and keep track of/report on number of retries | |
| - type: "Integration Tests" | |
| java: 17 | |
| mvnflags: "-DskipIntegrationTests=false -Denforcer.skip=true -Dcheckstyle.skip=true -Dlicense.skip=true -Dxml.skip=true -Dfailsafe.rerunFailingTestsCount=2" | |
| resultsdir: "**/target/failsafe-reports/**" | |
| # Do NOT exit immediately if one matrix job fails | |
| # This ensures ITs continue running even if Unit Tests fail, or visa versa | |
| fail-fast: false | |
| name: Run ${{ matrix.type }} | |
| # These are the actual CI steps to perform per job | |
| steps: | |
| # https://github.com/actions/checkout | |
| - name: Checkout codebase | |
| uses: actions/checkout@v4 | |
| # https://github.com/actions/setup-java | |
| - name: Install JDK ${{ matrix.java }} | |
| uses: actions/setup-java@v4 | |
| with: | |
| java-version: ${{ matrix.java }} | |
| distribution: 'temurin' | |
| cache: 'maven' | |
| # Run parallel Maven builds based on the above 'strategy.matrix' | |
| - name: Run Maven ${{ matrix.type }} | |
| env: | |
| TEST_FLAGS: ${{ matrix.mvnflags }} | |
| run: mvn --no-transfer-progress -V install -P-assembly -Pcoverage-report $TEST_FLAGS | |
| # If previous step failed, save results of tests to downloadable artifact for this job | |
| # (This artifact is downloadable at the bottom of any job's summary page) | |
| - name: Upload Results of ${{ matrix.type }} to Artifact | |
| if: ${{ failure() }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.type }} results | |
| path: ${{ matrix.resultsdir }} | |
| # Upload code coverage report to artifact, so that it can be shared with the 'codecov' job (see below) | |
| - name: Upload code coverage report to Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.type }} coverage report | |
| path: 'dspace/target/site/jacoco-aggregate/jacoco.xml' | |
| retention-days: 14 | |
| # Codecov upload is a separate job in order to allow us to restart this separate from the entire build/test | |
| # job above. This is necessary because Codecov uploads seem to randomly fail at times. | |
| # See https://community.codecov.com/t/upload-issues-unable-to-locate-build-via-github-actions-api/3954 | |
| codecov: | |
| # Must run after 'tests' job above | |
| needs: tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| # Download artifacts from previous 'tests' job | |
| - name: Download coverage artifacts | |
| uses: actions/download-artifact@v4 | |
| # Now attempt upload to Codecov using its action. | |
| # NOTE: We use a retry action to retry the Codecov upload if it fails the first time. | |
| # | |
| # Retry action: https://github.com/marketplace/actions/retry-action | |
| # Codecov action: https://github.com/codecov/codecov-action | |
| - name: Upload coverage to Codecov.io | |
| uses: Wandalen/[email protected] | |
| with: | |
| action: codecov/codecov-action@v4 | |
| # Ensure codecov-action throws an error when it fails to upload | |
| with: | | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| # Try re-running action 5 times max | |
| attempt_limit: 5 | |
| # Run again in 30 seconds | |
| attempt_delay: 30000 |