Skip to content

Commit 88311e0

Browse files
committed
Add README
1 parent 819ebb7 commit 88311e0

File tree

4 files changed

+62
-3
lines changed

4 files changed

+62
-3
lines changed

.github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Test
1+
name: Tests
22

33
on: [ push, pull_request ]
44

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 GitHub
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# :gear: `setup-gh` ![](https://github.com/github-developer/setup-gh/workflows/Tests/badge.svg)
2+
> An example action, demonstrating how CLI authors may develop actions that allow setup their of CLIs on GitHub's hosted runners, using JavaScript
3+
4+
## About
5+
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.
6+
7+
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.
8+
9+
## Usage
10+
11+
Setup the `gh` CLI:
12+
13+
```yaml
14+
steps:
15+
- uses: github-developer/setup-gh@v1
16+
```
17+
18+
A specific version of the `gh` CLI can be installed:
19+
20+
```yaml
21+
steps:
22+
- uses: github-developer/setup-gh@v1
23+
with:
24+
version:
25+
1.1.0
26+
```
27+
28+
## Inputs
29+
The actions supports the following inputs:
30+
31+
- `version`: The version of `gh` to install, defaulting to `1.2.0`
32+
33+
## License
34+
[MIT](LICENSE).

package.json

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,12 @@
1010
"all": "npm run lint && npm run prepare && npm run test"
1111
},
1212
"keywords": [],
13-
"author": "Steve Winton <[email protected]> (https://github.com/swinton)",
14-
"license": "ISC",
13+
"homepage": "https://github.com/github-developer/setup-gh",
14+
"license": "MIT",
15+
"repository": {
16+
"type": "git",
17+
"url": "git+https://github.com/github-developer/setup-gh.git"
18+
},
1519
"dependencies": {
1620
"@actions/core": "^1.2.6",
1721
"@actions/tool-cache": "^1.6.0"

0 commit comments

Comments
 (0)