Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
alvaromartmart committed Mar 14, 2024
1 parent 48424bf commit f1774d7
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# setup-seqerakit
Github Action to set up seqerakit

A Github Action to set up everything needed to run [`seqerakit`](https://github.com/seqeralabs/seqera-kit), including setup of [`tower-cli`](https://github.com/seqeralabs/tower-cli) if not found already in the Github Action runner environment.
## Usage

```yml
- name: Compare coverage
uses: alvaromartmart/setup-seqerakit@v1
with:
api-endpoint: "https://tower.nf/api"
token: ${{ secrets.SEQERA_PLATFORM_PERSONAL_ACCESS_TOKEN }}
- name: Use seqerakit
run: |
seqerakit my_data.yml
```
### Action inputs
| Name | Description | Default |
| --- | --- | --- |
| `token` | Personal access token defined in Seqera Platform. Store it as a Github secret to avoid disclosing it. | - |
| `api-endpoint` | Seqera platform API endpoint | https://tower.nf/api


#### Outputs

None

## License

[MIT](LICENSE)

0 comments on commit f1774d7

Please sign in to comment.