https://github.com/timo-dk/setup-dxc

A GitHub Action to setup the DirectXShaderCompiler in the workflow.
https://github.com/timo-dk/setup-dxc

Last synced: 1 day ago
JSON representation

A GitHub Action to setup the DirectXShaderCompiler in the workflow.

• Host: GitHub
• URL: https://github.com/timo-dk/setup-dxc
• Owner: Timo-DK
• License: mit
• Created: 2021-05-01T13:04:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-16T19:10:41.000Z (almost 2 years ago)
• Last Synced: 2025-01-13T16:19:50.129Z (1 day ago)
• Language: TypeScript
• Size: 38.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Napokue/setup-dxc

A GitHub Action to setup the [DirectXShaderCompiler](https://github.com/microsoft/DirectXShaderCompiler) in the workflow.

This action will do the following steps:

* Download the the zip file from the [release page](https://github.com/microsoft/DirectXShaderCompiler/releases). Based on the input it will by default download the "latest" tagged release, otherwise it will download the specified tagged release.

* Extract the zip file to the `%ProgramW6432%\dxc` directory.

* Add the location of the bin folder of the compiler (`%ProgramW6432%\dxc\bin\x64`) to the PATH variable.

* Add the location of the bin folder of the compiler (`%ProgramW6432%\dxc\bin\x64`) to the `outputs`.

## Inputs

### `tag`

**Optional** that will download a tagged DirectXShaderCompiler release. When not specified, the latest tag will be downloaded.

## Outputs

### `dxc-path`

Location of the dxc compiler. This location will be `%ProgramW6432%\dxc\bin\x64`.

## Example Usage

```yml

- name: setup-dxc

  id: setup-dxc

  uses: napokue/[email protected] # where x.x.x is Major, Minor, and Revision respectively

# In the outputs, the variable "dxc-path" is available for use. This is the location of the dxc compiler.

- name: test-dxc-default

  run: |

    echo "setup-dxc-default - ${{steps.setup-dxc-default.outputs.dxc-path}}"

    dxc -help

```