https://github.com/dfinity/setup-dfx

GitHub Action to set up dfx
https://github.com/dfinity/setup-dfx

Last synced: 5 days ago
JSON representation

GitHub Action to set up dfx

• Host: GitHub
• URL: https://github.com/dfinity/setup-dfx
• Owner: dfinity
• License: apache-2.0
• Created: 2023-07-06T09:28:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-01T21:25:29.000Z (7 months ago)
• Last Synced: 2024-08-02T06:16:01.500Z (3 months ago)
• Homepage:
• Size: 38.1 KB
• Stars: 6
• Watchers: 6
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-internet-computer - setup-dfx

README

        
# dfinity/setup-dfx

The `dfinity/setup-dfx` repository provides a GitHub Action to set up the [`dfx` software development kit (SDK)](https://github.com/dfinity/sdk/) for [Internet Computer](https://internetcomputer.org). 

## Usage

To use this action in your GitHub workflow, include it as a step in your workflow configuration:

```yml

jobs:

  example-job:

    runs-on: ubuntu-latest 

    steps:

    - name: Checkout repository

      uses: actions/checkout@v2

    - name: Install dfx

      uses: dfinity/setup-dfx@main

    - name: Confirm successful installation

      run: dfx --version

```

The action is designed to run on both `ubuntu-` and `macos-` runners.

## Specifying a dfx Version

You can specify a particular version of dfx to install using the `dfx-version` input:

```yml

    - name: Install dfx

      uses: dfinity/setup-dfx@main

      with: 

        dfx-version: "0.14.2-beta.2"

```

## Inputs

| Input         | Description   |

|---------------|---------------|

| `dfx-version` | (Optional) The version of dfx to install. If "auto" (the default), the version will be taken from dfx.json if present, otherwise latest.  If "latest", the latest version will be installed.

## Contributing

Contributions to the `dfinity/setup-dfx` repository are welcome! 

## License

This project is licensed under the [Apache 2.0 License](LICENSE).