Browse Source

Add link to doc for creating and using encyrpted secrets (#123)

eric sciple 5 years ago
parent
commit
bc50a995b8
3 changed files with 10 additions and 3 deletions
  1. 2 1
      README.md
  2. 2 1
      action.yml
  3. 6 1
      src/misc/generate-docs.ts

+ 2 - 1
README.md

@@ -47,7 +47,8 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
 
 
     # Auth token used to fetch the repository. The token is stored in the local git
     # Auth token used to fetch the repository. The token is stored in the local git
     # config, which enables your scripts to run authenticated git commands. The
     # config, which enables your scripts to run authenticated git commands. The
-    # post-job step removes the token from the git config.
+    # post-job step removes the token from the git config. [Learn more about creating
+    # and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
     # Default: ${{ github.token }}
     # Default: ${{ github.token }}
     token: ''
     token: ''
 
 

+ 2 - 1
action.yml

@@ -13,7 +13,8 @@ inputs:
     description: >
     description: >
       Auth token used to fetch the repository. The token is stored in the local
       Auth token used to fetch the repository. The token is stored in the local
       git config, which enables your scripts to run authenticated git commands.
       git config, which enables your scripts to run authenticated git commands.
-      The post-job step removes the token from the git config.
+      The post-job step removes the token from the git config. [Learn more about
+      creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
     default: ${{ github.token }}
     default: ${{ github.token }}
   persist-credentials:
   persist-credentials:
     description: 'Whether to persist the token in the git config'
     description: 'Whether to persist the token in the git config'

+ 6 - 1
src/misc/generate-docs.ts

@@ -65,9 +65,14 @@ function updateUsage(
       let segment: string = description
       let segment: string = description
       if (description.length > width) {
       if (description.length > width) {
         segment = description.substr(0, width + 1)
         segment = description.substr(0, width + 1)
-        while (!segment.endsWith(' ')) {
+        while (!segment.endsWith(' ') && segment) {
           segment = segment.substr(0, segment.length - 1)
           segment = segment.substr(0, segment.length - 1)
         }
         }
+
+        // Trimmed too much?
+        if (segment.length < width * 0.67) {
+          segment = description
+        }
       } else {
       } else {
         segment = description
         segment = description
       }
       }