Skip to content

Commit 5628d88

Browse files
committed
update docs
1 parent f206d44 commit 5628d88

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ GitHub Action for authenticating to Alibaba Cloud with `GitHub Actions OIDC toke
99
Inputs
1010
======
1111

12-
* ``role-arn-to-assume``: (Required) The arn of Ram role.
13-
* ``oidc-provider-arn``: (Required) The arn of OIDC IdP.
12+
* ``role-arn-to-assume``: (**Required**) The arn of RAM role.
13+
* ``oidc-provider-arn``: (**Required**) The arn of OIDC IdP.
1414
* ``export-environment-variables``: (Optional) Export common environment variables. The default value is: ``false``
1515
* ``set-outputs``: (Optional) Setting action outputs. The default value is: ``false``
1616
* ``audience``: (Optional) The audience (aud) parameter in GitHub's generated OIDC
@@ -24,9 +24,9 @@ Outputs
2424

2525
Only available when ``set-outputs`` is ``true``.
2626

27-
* ``access-key-id``: (Optional) The AccessKey ID.
28-
* ``access-key-secret``: (Optional) The AccessKey secret.
29-
* ``security-token``: (Optional) The STS token.
27+
* ``access-key-id``: (Optional) The Alibaba Cloud Access Key ID.
28+
* ``access-key-secret``: (Optional) The Alibaba Cloud Access Key Secret.
29+
* ``security-token``: (Optional) The Alibaba Cloud STS Token.
3030

3131

3232
Example Usage

action.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@ inputs:
5050

5151
set-outputs:
5252
description: |-
53-
If true, the action will setting credentials as action outputs, including:
53+
If true, the action will set credentials as action outputs, including:
5454
- access-key-id
5555
- access-key-secret
5656
- security-token
57+
If false, the action will not set any action outputs.
5758
default: 'false'
5859
required: false
5960

@@ -65,13 +66,16 @@ inputs:
6566

6667
outputs:
6768
access-key-id:
68-
description: access key id
69+
description: |-
70+
The Alibaba Cloud Access Key ID
6971
7072
access-key-secret:
71-
description: access key secret
73+
description: |-
74+
The Alibaba Cloud Access Key Secret
7275
7376
security-token:
74-
description: security token
77+
description: |-
78+
The Alibaba Cloud Security Token (STS Token)
7579
7680
branding:
7781
icon: 'lock'

0 commit comments

Comments
 (0)