followup on breaking changes output (#26)

Co-authored-by: Jef LeCompte <[email protected]>

.gitignore

@@ -1,2 +1,4 @@
-/.tmp/
+.idea/
+.tmp/
+.vscode/
 node_modules/

README.md

@@ -53,6 +53,12 @@ Parameter | Description | Required | Default
 
 > These parameters are derived from [`action.yml`](./action.yml).
 
+### Output
+
+| Parameter | Description                                                       |
+|-----------|-------------------------------------------------------------------|
+| `results` | The generated breaking change messages with the file annotations. |
+
 ### Constraints
 
 For the `buf-breaking-action` to detect changes successfully, both the `input` and the `against`

action.yml

@@ -9,6 +9,7 @@ inputs:
   # https://docs.buf.build/inputs#specifying-an-input
   input:
     description: "The Input path. Defaults to the root of the current repository."
+    required: false
     default: "."
   # For more on "against" in breaking change detection:
   # https://docs.buf.build/breaking/usage#run-breaking-change-detection
@@ -17,15 +18,18 @@ inputs:
     required: true
   buf_input_https_username:
     description: "The username for the repository to check compatibility against."
+    required: false
     default: ${{ github.actor }}
   buf_input_https_password:
     description: "The password for the repository to check compatibility against."
+    required: false
     default: ${{ github.token }}
   buf_token:
     description: "The buf authentication token used for private inputs."
+    required: false
 outputs:
   results:
     description: "The generated breaking change messages with the file annotations."
 runs:
-  using: "node12"
+  using: "node16"
   main: "./dist/main.js"