{"id":19133788,"url":"https://github.com/diligentgraphics/github-action","last_synced_at":"2025-08-24T19:07:36.998Z","repository":{"id":50626777,"uuid":"485548644","full_name":"DiligentGraphics/github-action","owner":"DiligentGraphics","description":"Custom actions used by the Diligent Engine CI","archived":false,"fork":false,"pushed_at":"2025-03-27T16:05:40.000Z","size":55,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T17:24:16.331Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DiligentGraphics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-04-25T22:03:35.000Z","updated_at":"2025-03-13T23:59:00.000Z","dependencies_parsed_at":"2024-05-04T00:34:07.905Z","dependency_job_id":"6914bfa3-f1c4-4ec5-b374-55fe242c759e","html_url":"https://github.com/DiligentGraphics/github-action","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiligentGraphics%2Fgithub-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiligentGraphics%2Fgithub-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiligentGraphics%2Fgithub-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiligentGraphics%2Fgithub-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DiligentGraphics","download_url":"https://codeload.github.com/DiligentGraphics/github-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249638250,"owners_count":21304305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T06:23:49.619Z","updated_at":"2025-04-19T07:33:20.542Z","avatar_url":"https://github.com/DiligentGraphics.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# github-action\n\nCustom actions used by the [Diligent Engine](https://github.com/DiligentGraphics/DiligentEngine) CI.\n\n## checkout\n\nChecks out the specified module and its required dependent modules.\n\nExample:\n\n```yml\nsteps:\n- name: Checkout\n    uses: DiligentGraphics/github-action/checkout@master\n    with:\n      module:     Tools # Optional; by default, current module is checked out\n      submodules: true  # Optional; by default, 'recursive' is used\n```\n\n## setup-build-env\n\nSets up the build environment and downloads the required prerequisites:\n\n- Ninja\n- Vulkan SDK\n- Java\n- Emscripten SDK\n- Required linux libraries\n\nExample:\n\n```yml\nsteps:\n- name: Set up build environment\n    uses: DiligentGraphics/github-action/setup-build-env@v1\n    with:\n      platform:           Win32     # UWP, Linux, MacOS, tvOS, iOS, Android, Web\n      cmake-generator:    Ninja     # Optional\n      ninja-vs-arch:      x64       # When Ninja is used for VS build\n      vulkan-sdk-version: 1.3.290.0 # Optional, see defaults below\n      java-version:       17        # Optional, see defaults below\n      emsdk-version:      4.0.0     # Optional, see defaults below\n```\n\nDefault component versions are specified in the table below:\n\n|  Component      |      v1       |\n|-----------------|---------------|\n| Vulkan SDK      | 1.3.290.0     |\n| Java            | 17            |\n| Emscripten  SDK | 4.0.0         |\n\n\nLinux libraires:\n\n* v1\n  - build-essential\n  - libx11-dev\n  - libgl1-mesa-dev\n  - libxrandr-dev\n  - libxinerama-dev\n  - libxcursor-dev\n  - libxi-dev\n\n\n## configure-cmake\n\nConfigures CMake; creates a helper `CMakeLists.txt` file, if necessary.\n\nExample:\n\n```yml\nsteps:\n- name: Configure CMake\n  if: success()\n  uses: DiligentGraphics/github-action/configure-cmake@v1\n  with:\n    generator:             Visual Studio 17 2022\n    vs-arch:               x64   # Required for VS generator\n    build-type:            Debug # Required\n    cmake-args:            -DDILIGENT_DEVELOPMENT=ON # Optional extra CMake arguments\n    osx-deployment-target: 11         # Required for iOS/tvOS\n    osx-architectures:     arm64      # Required for iOS/tvOS\n    cc:                    clang-12   # Optional for Linux\n    cxx:                   clang++-12 # Optional for Linux\n    windows-sdk-version:   10.0.22621.0 # Optional for Visual Studio generator\n```\n\nDefault versions are specified in the table below:\n\n|  Parameter            |      v1       |\n|-----------------------|---------------|\n| osx-deployment-target |      11       |\n\nThe action sets the following environment variables:\n* `DILIGENT_BUILD_TYPE`  - Build type (`${{inputs.build-type}}`)\n* `DILIGENT_BUILD_DIR`   - Build directory (`${{runner.workspace}}/build`)\n* `DILIGENT_INSTALL_DIR` - Install directory (`${{runner.workspace}}/build/install`)\n\n\n## build\n\nRuns the build for the current configuration.\n\nExample:\n\n```yml\nsteps:\n- name: Build\n  if: success()\n  uses: DiligentGraphics/github-action/build@master\n  with:\n    target: install # Optional target\n```\n\n\n## run-core-tests\n\nRuns Diligent Core tests for the current configuration.\n\nExample:\n\n```yml\nsteps:\n- name: DiligentCoreTest\n  if:   success()\n  uses: DiligentGraphics/github-action/run-core-tests@master\n```\n\n\n## run-core-gpu-tests\n\nRuns Diligent Core GPU tests for the current configuration.\n\nExample:\n\n```yml\n- name: DiligentCoreAPITest D3D12 DXC\n  if:   success()\n  uses: DiligentGraphics/github-action/run-core-gpu-tests@master\n  with:\n    mode:                d3d12_sw\n    use-dxc:             true\n    non-separable-progs: false\n```\n\n\n## run-tools-tests\n\nRuns Diligent Tools tests for the current configuration.\n\nExample:\n\n```yml\nsteps:\n- name: DiligentToolsTest\n  if:   success()\n  uses: DiligentGraphics/github-action/run-tools-tests@master\n```\n\n\n## run-tools-gpu-tests\n\nRuns Diligent Tools GPU tests for the current configuration.\n\nExample:\n\n```yml\n- name: DiligentToolsGPUTest D3D11\n  if:   success()\n  uses: DiligentGraphics/github-action/run-tools-gpu-tests@master\n  with:\n    mode:    d3d11_sw\n```\n\n## run-sample-tests\n\nRuns sample and tutorial tests for the current configuration.\n\nExample:\n\n```yml\n- name: Sample Tests D3D11\n    uses: DiligentGraphics/github-action/run-sample-tests@v1\n    with:\n      mode:                d3d12_sw\n      golden-image-mode:   compare_update\n      non-separable-progs: false\n```\n\n\n## clean-disk-ubuntu\n\nRemoves unneeded packages and tools to free disk space.\n\nExample:\n\n```yml\n- name: Clean Disk\n  uses: DiligentGraphics/github-action/clean-disk-ubuntu@master\n  preserve-android-ndk: 27.0.12077973\n```\n\n\n## install-doxygen\n\nInstalls Doxygen.\n\nExample:\n\n```yml\n- name: Install Doxygen\n  uses: DiligentGraphics/github-action/install-doxygen@master\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiligentgraphics%2Fgithub-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiligentgraphics%2Fgithub-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiligentgraphics%2Fgithub-action/lists"}