Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
odanado committed Jun 15, 2024
1 parent 27bd458 commit 3dc5386
Showing 1 changed file with 12 additions and 22 deletions.
34 changes: 12 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You don't need to download assets and extract, add system pathes, this action wi

```yml
- name: Get conftest CLI
uses: KeisukeYamashita/[email protected]
uses: odanado/[email protected]
with:
repository: open-policy-agent/conftest
```
Expand All @@ -29,7 +29,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: KeisukeYamashita/[email protected]
- uses: odanado/[email protected]
with:
repository: spinnaker/kleat
tag: v0.3.0
Expand All @@ -38,24 +38,23 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: KeisukeYamashita/[email protected]
- uses: odanado/[email protected]
with:
repository: spinnaker/kleat
# Use the "kleat" command in the later steps
```

### Action inputs

| Name | Description | Default |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `arch` | The asset arch target. | `amd64` |
| `archive` | Archive type. Currently, `tar.gz`, `darwin` and `zip` is supported. | `tar.gz` |
| `installPath` | Path to install the extracted asset | UUID |
| `repository` | The GitHub repository where it is released | `true` |
| `number` | The number of the issue to post. | `github.event.issue.number` |
| `platform` | Assets target platform. `linux`, `darwin` is supported. | `linux` |
| `tag` | GitHub tag of the release | `latest` |
| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` |
| Name | Description | Default |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `arch` | The asset arch target. This value is case-insensitive. | `runner.arch` |
| `archive` | Archive type. Currently, `tar.gz`, `darwin` and `zip` is supported. | `tar.gz` |
| `installPath` | Path to install the extracted asset | UUID |
| `repository` | The GitHub repository where it is released | `true` |
| `platform` | Assets target platform. `linux`, `darwin` is supported. This value is case-insensitive. | `runner.os` |
| `tag` | GitHub tag of the release | `latest` |
| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` |

_Note: You cannot use this action if the asset name is not included in the asset name because the search is based on the three inputs(`arch`, `archive` and `platform`) in the asset.name field._

Expand All @@ -81,12 +80,3 @@ The user associated with the PAT must have write access to the repository.
## License

[MIT](LICENSE)

<!-- Badge links -->

[ci]: https://github.com/KeisukeYamashita/setup-release/workflows/build-test/badge.svg
[ci-status]: https://github.com/KeisukeYamashita/setup-release/actions?query=workflow%3Abuild-test
[marketplace]: https://img.shields.io/badge/Marketplace-Setup%20Release-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=
[marketplace-status]: https://github.com/marketplace/actions/setup-release
[mergify]: https://mergify.io
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/KeisukeYamashita/setup-release&style=flat

0 comments on commit 3dc5386

Please sign in to comment.