https://github.com/github-developer/example-setup-gh
An example action, demonstrating how CLI authors may develop actions that allow setup their of CLIs on GitHub's hosted runners, using JavaScript
https://github.com/github-developer/example-setup-gh
Last synced: about 1 month ago
JSON representation
An example action, demonstrating how CLI authors may develop actions that allow setup their of CLIs on GitHub's hosted runners, using JavaScript
- Host: GitHub
- URL: https://github.com/github-developer/example-setup-gh
- Owner: github-developer
- License: mit
- Created: 2020-11-10T22:44:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-26T20:55:31.000Z (3 months ago)
- Last Synced: 2025-05-02T09:50:16.868Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://git.io/setting-up-a-cli-on-github-s-hosted-runners
- Size: 668 KB
- Stars: 16
- Watchers: 1
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- jimsghstars - github-developer/example-setup-gh - An example action, demonstrating how CLI authors may develop actions that allow setup their of CLIs on GitHub's hosted runners, using JavaScript (JavaScript)
README
# :gear: `setup-gh` 
> An example action, demonstrating how CLI authors may develop actions that allow setup their of CLIs on GitHub's hosted runners, using JavaScript
## About
This action, which is intended _for demonstration use only_, sets up the GitHub CLI, [`gh`](https://github.com/cli/cli), on GitHub's hosted Actions runners.
This action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners, and will install and expose a specified version of the `gh` CLI on the runner environment.
## Usage
Setup the `gh` CLI:
```yaml
steps:
- uses: github-developer/setup-gh@v1
```
A specific version of the `gh` CLI can be installed:
```yaml
steps:
- uses: github-developer/setup-gh@v1
with:
version:
1.1.0
```
## Inputs
The actions supports the following inputs:
- `version`: The version of `gh` to install, defaulting to `1.2.0`
## Further reading
For information on Creating a JavaScript action, read [the docs](https://docs.github.com/actions/creating-actions/creating-a-javascript-action).
## License
[MIT](LICENSE).