_triggers.yml

{% metadata_file .yamato/project.metafile %} # All configuration that is used to create different configurations (used in for loops) is taken from this file.
---

# DESCRIPTION--------------------------------------------------------------------------
  # This configuration defines three main CI trigger patterns:
    # 1. Pull Request Validation: Validation performed on PR basis
    # 2. Nightly Development: Test set run nightly (validates most important test cases)
    # 3. Weekly Full Validation: Test set run weekly (validates all test cases to prevent any suprises)
  # Each pattern represents different balance between validation depth, execution time and CI resource usage

# TRIGGER PATTERNS-------------------------------------------------------------------
  # Pull Request:
    # This test validaes Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
    # Triggers on PRs to develop, develop-2.0.0, and release branches
    # Focuses on critical validation paths that we should validate before merging PRs
    # Cancels previous runs on new commits
    # Excludes draft PRs

  # Nightly:
    # This test validaes same subset as pull_request_trigger with addition of mobile/console tests and webgl builds
    # Runs daily on develop-2.0.0 (local configuration)
    # Includes all test types but only on trunk. TODO: Add validation for minimum supported editor in nightly
    # Adds platform-specific and APV validation

  # Weekly:
  # This test validaes same subset as develop_nightly but runs per all supported editors as well as executes code coverage test and runs project standards per project
    # Runs across all supported editor versions
    # Includes code coverage analysis
    # Validates all projects and standards

# CONFIGURATION STRUCTURE--------------------------------------------------------------
  # Jobs configurations are generated by ensuring that all dependencies are successful.
  # The dependencies are taken from _run-all.yml file where we can gather multiple tests into proper sets


#-----------------------------------------------------------------------------------

# Run all relevant tasks when a pull request targeting the develop or release branch is created or updated.
pull_request_trigger:
  name: Pull Request Trigger (develop, develop-2.0.0, & release branches)
  dependencies:
    # Run project standards to verify package/default project
    - .yamato/project-standards.yml#standards_ubuntu_testproject_trunk
    # Run package EditMode and Playmode tests on desktop platforms on trunk
    - .yamato/_run-all.yml#run_all_package_tests_trunk
    # Run project EditMode and PLaymode tests on desktop platforms on trunk 
    - .yamato/_run-all.yml#run_all_project_tests_trunk
    # Run one standalone test to make sure there are no obvious issues with most common platform (for example --fail-on-assert option is not present with package/project tests)
    - .yamato/desktop-standalone-tests.yml#desktop_standalone_test_testproject_win_il2cpp_trunk
  triggers:
    cancel_old_ci: true
    pull_requests:
      - targets:
          only:
            - "develop"
            - "develop-2.0.0"
            - "/release\/.*/"
      - drafts: false
            

# Run all tests on trunk on nightly basis.
# Same subset as pull_request_trigger with addition of mobile/desktop/console tests and webgl builds
# Those tests are all running on trunk editor (since it's daily and running all of them would add a lot of overhead)
develop_nightly:
  name: "\U0001F319 [Nightly] Run All Tests [Trunk]"
  triggers:
    recurring:
      - branch: develop-2.0.0
        frequency: daily
        rerun: always
  dependencies:
    # Run project standards to verify package/default project
    - .yamato/project-standards.yml#standards_ubuntu_testproject_trunk
    # Run APV jobs to make sure the change won't break any dependants
    - .yamato/wrench/preview-a-p-v.yml#all_preview_apv_jobs
    # Run package EditMode and Playmode tests on desktop platforms on trunk
    - .yamato/_run-all.yml#run_all_package_tests_trunk
    # Run project EditMode and PLaymode tests on desktop platforms on trunk 
    - .yamato/_run-all.yml#run_all_project_tests_trunk
    # Run Runtime tests on desktop players on trunk
    - .yamato/_run-all.yml#run_all_project_tests_desktop_standalone_trunk
    # Run Runtime tests on mobile players on trunk
    - .yamato/_run-all.yml#run_all_project_tests_mobile_standalone_trunk
    # Run Runtime tests on console players on trunk
    - .yamato/_run-all.yml#run_all_project_tests_console_standalone_trunk
    # Build player for webgl platform on trunk
    - .yamato/_run-all.yml#run_all_webgl_builds_trunk
    # Build player for webgl platform on trunk
    - .yamato/project-updated-dependencies-test.yml#updated-dependencies_testproject_NGO_ubuntu_trunk


# Run all tests on weekly bases
# Same subset as develop_nightly but runs per all supported editors as well as executes code coverage test and runs project standards per project
# It's not running wrench jobs since those will run either way in nightly test run
# This in contrast to nightly checks will run tests on all editors (not only trunk). Running those on weekly basis and trunk tests nightly should be a good balance between making sure that tests are passing and overhead of running lots of tests
develop_weekly_trunk:
  name: "\U0001F319 [Weekly] Run All Tests"
  triggers:
    recurring:
      - branch: develop-2.0.0
        frequency: weekly
        rerun: always
  dependencies:
    # Run project standards to verify package/default project
    - .yamato/_run-all.yml#run_all_projects_standards
    # Run package EditMode and Playmode tests on desktop platforms
    - .yamato/_run-all.yml#run_all_package_tests
    # Run project EditMode and PLaymode tests on desktop platforms
    - .yamato/_run-all.yml#run_all_project_tests
    # Run Runtime tests on desktop players
    - .yamato/_run-all.yml#run_all_project_tests_desktop_standalone
    # Run Runtime tests on mobile players
    - .yamato/_run-all.yml#run_all_project_tests_mobile_standalone
    # Run Runtime tests on console players
    - .yamato/_run-all.yml#run_all_project_tests_console_standalone
    # Build player for webgl platform on trunk
    - .yamato/_run-all.yml#run_all_webgl_builds
    # Run code coverage test
    - .yamato/code-coverage.yml#code_coverage_ubuntu_trunk