docs: add outputs

FuelLabs · Mar 20, 2024 · c87963d · c87963d
1 parent efef3e4
commit c87963d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/update-sdk/README.md b/update-sdk/README.md
@@ -28,13 +28,17 @@ A github action to update the SDK packages.
 | ------------ | ---------------------------------------------------------- | -------------------------- |
 | repository   | Github Repository                                          | `${{ github.repository }}` |
 | changeset    | If your repository uses changesets, set this to true       | `false`                    |
-| branch       | The branch that will be used to create the PR              | `main`                     |
+| branch       | The branch that will be used as base to create the PR      | `main`                     |
 | packages     | Packages to update (multiline input or comma separated)    | ''                         |
 | npm-tag      | NPM tag (e.g. latest or next)                              | `latest`                   |
 
 ### Outputs
 
-No outputs defined
+| Name         | Description                                                |
+| ------------ | ---------------------------------------------------------- |
+| has-updates  | If there are updates                                       |
+| branch       | The branch with the updated packages                       |
+| pr           | The PR url with the updated packages                       |
 
 ## License
 

diff --git a/update-sdk/action.yaml b/update-sdk/action.yaml
@@ -18,6 +18,14 @@ inputs:
     description: "Packages to update"
     required: true
 
+outputs:
+  has-updates:
+    description: "If there are updates"
+  branch:
+    description: "The branch with the updated packages"
+  pr:
+    description: "The PR url with the updated packages"
+
 runs:
   using: "node20"
   main: "dist/index.js"