release v2

README.md

@@ -3,11 +3,11 @@
 [![Continuous Integration](https://github.com/yizhoumo/setup-ossutil/actions/workflows/ci.yml/badge.svg)](https://github.com/yizhoumo/setup-ossutil/actions/workflows/ci.yml)
 [![Functional](https://github.com/yizhoumo/setup-ossutil/actions/workflows/functional.yml/badge.svg)](https://github.com/yizhoumo/setup-ossutil/actions/workflows/functional.yml)
 
-This action sets up [Alibaba Cloud OSSUTIL](https://github.com/aliyun/ossutil)
+This action provides the following functionality for GitHub Actions users:
-for use in actions by:
 
-- downloading and caching ossutil by version and adding to PATH
+- Downloading and caching distribution of the requested [Alibaba Cloud OSSUTIL](https://github.com/aliyun/ossutil)
-- configuring ossutil with your credentials
+  version, and adding it to the PATH
+- Optionally configuring ossutil with the provided credential
 
 ## Usage
 
@@ -15,14 +15,21 @@ See [action.yml](action.yml)
 
 ```yaml
 steps:
-- uses: actions/checkout@v1
+- uses: yizhoumo/setup-ossutil@v2
-- uses: yizhoumo/setup-ossutil@v1
   with:
+    ## The version to download and use, or 'latest' for the latest version.
+    ossutil-version: '1.7.18'
+
+    # The following parameters are (optionally) used to config the credential.
+    ## The endpoint of the region in which the bucket is located.
     endpoint: ${{ secrets.OSS_ENDPOINT }}
+    ## The AccessKey ID of the credential.
     access-key-id: ${{ secrets.OSS_ACCESS_KEY_ID }}
+    ## The AccessKey Secret of the credential.
     access-key-secret: ${{ secrets.OSS_ACCESS_KEY_SECRET }}
-    sts-token: ${{ secrets.OSS_STS_TOKEN }} # Optional
+    ## The STS Token of the credential. Only required for temporary access.
-    ossutil-version: '1.7.14' # Optional. Use 'latest' for the latest version.
+    sts-token: ${{ secrets.OSS_STS_TOKEN }}
+
 - run: ossutil cp -f file-to-upload.txt oss://your-bucket/path
 ```
 

action.yml

@@ -12,18 +12,18 @@ inputs:
   ossutil-version:
     description: 'The OSSUTIL version to download and use, or "latest" for the latest version.'
     required: true
-    default: '1.7.14'
+    default: '1.7.18'
   endpoint:
-    description: 'The endpoint of your bucket'
+    description: 'The endpoint of the region in which the bucket is located.'
     required: false
   access-key-id:
-    description: 'The AccessKey ID of the credentials'
+    description: 'The AccessKey ID of the credential.'
     required: false
   access-key-secret:
-    description: 'The AccessKey Secret of the credentials'
+    description: 'The AccessKey Secret of the credential.'
     required: false
   sts-token:
-    description: 'The STS Token of the credentials'
+    description: 'The STS Token of the credential. Only required for STS temporary access credential.'
     required: false
 
 # Define your outputs here.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "setup-ossutil",
-  "description": "GitHub Action to setup ossutil",
+  "description": "Set up your GitHub Actions workflow with a specific version of ossutil.",
-  "version": "1.1.3",
+  "version": "2.0.0",
   "author": "Rimo",
   "private": true,
   "homepage": "https://github.com/yizhoumo/setup-ossutil",