Skip to content

Commit 2ef55d9

Browse files
committed
update docs
1 parent b438fb2 commit 2ef55d9

File tree

1 file changed

+35
-23
lines changed

1 file changed

+35
-23
lines changed

Diff for: README.rst

+35-23
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,6 @@ GitHub Action for authenticating to Alibaba Cloud with `GitHub Actions OIDC toke
66
.. contents::
77

88

9-
Inputs
10-
======
11-
12-
* ``role-arn-to-assume``: (**Required**) The arn of RAM role.
13-
* ``oidc-provider-arn``: (**Required**) The arn of OIDC IdP.
14-
* ``export-environment-variables``: (Optional) Export common environment variables. The default value is: ``false``
15-
* ``set-outputs``: (Optional) Setting action outputs. The default value is: ``false``
16-
* ``audience``: (Optional) The audience (aud) parameter in GitHub's generated OIDC
17-
token. The default value is: ``actions.github.com``
18-
* ``role-duration-seconds``: (Optional) The validity period of the STS token. The default value is: ``3600``
19-
* ``role-session-name``: (Optional) The custom name of the role session. The default value is: ``github-actions-<orgName>-<repoName>``
20-
* ``region``: (Optional) The region id of STS endpoint. The default value is: ``ap-southeast-1``
21-
22-
Outputs
23-
========
24-
25-
Only available when ``set-outputs`` is ``true``.
26-
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.
30-
31-
329
Example Usage
3310
==============
3411

@@ -76,6 +53,41 @@ Or
7653
stat oss://test-bucket
7754
7855
56+
Inputs
57+
======
58+
59+
* ``role-arn-to-assume``: (**Required**) The arn of RAM role.
60+
* ``oidc-provider-arn``: (**Required**) The arn of OIDC IdP.
61+
* ``export-environment-variables``: (Optional) Export common environment variables, including:
62+
63+
- ``ALIBABA_CLOUD_ACCESS_KEY_ID``
64+
- ``ALIBABA_CLOUD_ACCESS_KEY_SECRET``
65+
- ``ALIBABA_CLOUD_SECURITY_TOKEN``
66+
- ``ALICLOUD_ACCESS_KEY``
67+
- ``ALICLOUD_SECRET_KEY``
68+
- ``ALICLOUD_ACCESS_KEY_STS_TOKEN``
69+
- ``ALIBABACLOUD_ACCESS_KEY_ID``
70+
- ``ALIBABACLOUD_ACCESS_KEY_SECRET``
71+
- ``ALIBABACLOUD_SECURITY_TOKEN``
72+
73+
The default value is: ``false``
74+
* ``set-outputs``: (Optional) Setting action outputs. The default value is: ``false``
75+
* ``audience``: (Optional) The audience (aud) parameter in GitHub's generated OIDC
76+
token. The default value is: ``actions.github.com``
77+
* ``role-duration-seconds``: (Optional) The validity period of the STS token. The default value is: ``3600``
78+
* ``role-session-name``: (Optional) The custom name of the role session. The default value is: ``github-actions-<orgName>-<repoName>``
79+
* ``region``: (Optional) The region id of STS endpoint. The default value is: ``ap-southeast-1``
80+
81+
Outputs
82+
========
83+
84+
Only available when ``set-outputs`` is ``true``.
85+
86+
* ``access-key-id``: (Optional) The Alibaba Cloud Access Key ID.
87+
* ``access-key-secret``: (Optional) The Alibaba Cloud Access Key Secret.
88+
* ``security-token``: (Optional) The Alibaba Cloud STS Token.
89+
90+
7991
RAM Configuration
8092
==================
8193

0 commit comments

Comments
 (0)