docs: add token input description

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
hoverkraft-tech · Feb 15, 2024 · cf555cf · cf555cf
1 parent bd9c9b0
commit cf555cf
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 9 deletions.
diff --git a/actions/get-matrix-outputs/README.md b/actions/get-matrix-outputs/README.md
@@ -1,6 +1,9 @@
 <!-- start branding -->
 <!-- end branding -->
 <!-- start title -->
+
+# GitHub Action: Get Matrix Outputs
+
 <!-- end title -->
 <!-- start badges -->
 <!-- end badges -->
@@ -19,25 +22,30 @@ Download matrix ouputs from artifacts, because GitHub action does not handle job
     # The name of the artifact to download.
     artifact-name: ""
 
-    # Define weather to remove the downloaded artifact after reading.
+    # Define weather to remove the downloaded artifact after reading. Requires token input.
     # Default: true
     remove-artifact: ""
+
+    # GitHub token with read and write access to actions for the repository.
+    # Default: ${{ github.token }}
+    token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 <!-- end usage -->
 <!-- start inputs -->
 
-| **Input**                        | **Description**                                                 | **Default**       | **Required** |
-| -------------------------------- | --------------------------------------------------------------- | ----------------- | ------------ |
-| **<code>artifact-name</code>**   | The name of the artifact to download.                           |                   | **true**     |
-| **<code>remove-artifact</code>** | Define weather to remove the downloaded artifact after reading. | <code>true</code> | **false**    |
+| **Input**                        | **Description**                                                                       | **Default**                      | **Required** |
+| -------------------------------- | ------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
+| **<code>artifact-name</code>**   | The name of the artifact to download.                                                 |                                  | **true**     |
+| **<code>remove-artifact</code>** | Define weather to remove the downloaded artifact after reading. Requires token input. | <code>true</code>                | **false**    |
+| **<code>token</code>**           | GitHub token with read and write access to actions for the repository.                | <code>${{ github.token }}</code> | **false**    |
 
 <!-- end inputs -->
 <!-- start outputs -->
 
-| \***\*Output\*\***  | \***\*Description\*\***           | \***\*Default\*\*** | \***\*Required\*\*** |
-| ------------------- | --------------------------------- | ------------------- | -------------------- |
-| <code>result</code> | The matrix combined JSON outputs. | undefined           | undefined            |
+| **Output**          | **Description**                   | **Default** | **Required** |
+| ------------------- | --------------------------------- | ----------- | ------------ |
+| <code>result</code> | The matrix combined JSON outputs. | undefined   | undefined    |
 
 <!-- end outputs -->
 <!-- start [.github/ghadocs/examples/] -->

diff --git a/actions/get-matrix-outputs/action.yml b/actions/get-matrix-outputs/action.yml
@@ -13,7 +13,7 @@ inputs:
     description: "The name of the artifact to download."
     required: true
   remove-artifact:
-    description: "Define weather to remove the downloaded artifact after reading."
+    description: "Define weather to remove the downloaded artifact after reading. Requires token input."
     required: false
     default: "true"
   token: