Skip to content

Commit

Permalink
chore: format README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nikolaymatrosov committed Nov 2, 2024
1 parent 5966c24 commit 58ed412
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ The action issues new Yandex Cloud IAM token and puts it in the output.
yc-sa-json-credentials: ${{ secrets.YC_SA_JSON_CREDENTIALS }}
```
`yc-sa-json-credentials` should contain JSON with authorized key for Service Account. More info in [Yandex Cloud IAM documentation](https://cloud.yandex.ru/docs/container-registry/operations/authentication#sa-json).
`yc-sa-json-credentials` should contain JSON with authorized key for Service Account. More info
in [Yandex Cloud IAM documentation](https://cloud.yandex.ru/docs/container-registry/operations/authentication#sa-json).

Alternative usage:

Expand All @@ -36,22 +37,23 @@ Alternative usage:
yc-private-key: ${{ secrets.YC_PRIVATE_KEY }}
```

`yc-key-id`, `yc-service-account-id` and `yc-private-key` are `id`, `service_account_id` and `private_key` respectively from Service Account json key.
`yc-key-id`, `yc-service-account-id` and `yc-private-key` are `id`, `service_account_id` and `private_key` respectively
from Service Account json key.

### Action Inputs

| Name | Description | Default |
| ------------------------ | --------------------------------------------------------------------- | ------------------------------------- |
| `yc-sa-json-credentials` | Json containing authorized key for Service Account | ${{ secrets.YC_SA_JSON_CREDENTIALS }} |
| `yc-key-id` | "id" field from Service Account json key. | ${{ secrets.YC_KEY_ID }} |
| `yc-service-account-id` | "service_account_id" field from Service Account json key. | ${{ secrets.YC_SERVICE_ACCOUNT_ID }} |
| `yc-private-key` | "private_key" field from Service Account json key. | ${{ secrets.YC_PRIVATE_KEY }} |
| `mask-token` | Mask generated IAM token (use "false" for sharing token between jobs) | true |
| Name | Description | Default |
|--------------------------|-----------------------------------------------------------------------|-----------------------------------------|
| `yc-sa-json-credentials` | Json containing authorized key for Service Account | `${{ secrets.YC_SA_JSON_CREDENTIALS }}` |
| `yc-key-id` | "id" field from Service Account json key. | `${{ secrets.YC_KEY_ID }}` |
| `yc-service-account-id` | "service_account_id" field from Service Account json key. | `${{ secrets.YC_SERVICE_ACCOUNT_ID }}` |
| `yc-private-key` | "private_key" field from Service Account json key. | `${{ secrets.YC_PRIVATE_KEY }}` |
| `mask-token` | Mask generated IAM token (use "false" for sharing token between jobs) | `true` |

### Action Outputs

| Name | Description |
| ------- | ------------------- |
|---------|---------------------|
| `token` | Generated IAM token |

## Prerequisites
Expand Down

0 comments on commit 58ed412

Please sign in to comment.