Apply suggestions from review

ageorgou · ageorgou · commit d74d6b7a8e6c · 2021-08-23T20:29:25.000+01:00
diff --git a/README.md b/README.md
@@ -52,13 +52,13 @@ The maximum number of nested folders to show files within. A higher number will
 
 Default: 9
 
-### `push`
+### `should_push`
 
 Whether to make a new commit with the diagram and push it to the original repository.
 
 Should be a boolean value, i.e. `true` or `false`. See `commit_message` and `branch` for how to customise the commit.
 
-Default: `false`
+Default: `true`
 
 ### `commit_message`
 
@@ -126,7 +126,7 @@ Example:
     path: downloads
   # Diagram now available at downloads/images/diagram.svg
 ```
-Note that this will still also create a commit, unless you specify `push: false`!
+Note that this will still also create a commit, unless you specify `should_push: false`!
 
 Alternatively, the SVG description of the diagram is available in the `svg` output,
 which you can refer to in your workflow as e.g. `${{ steps.make_diagram.outputs.svg }}`.
diff --git a/action.yml b/action.yml
@@ -23,7 +23,7 @@ inputs:
   branch:
     description: "The branch name to push the diagram to (branch will be created if it does not yet exist). For example: diagram"
     required: false
-  push:
+  should_push:
     description: "Whether to push the new commit back to the repository. Must be true or false. Default: true"
     required: false
     default: true
diff --git a/index.js b/index.js
@@ -26299,7 +26299,7 @@ var main = async () => {
     core.info("[INFO] No changes to the repo detected, exiting");
     return;
   }
-  const shouldPush = core.getBooleanInput("push");
+  const shouldPush = core.getBooleanInput("should_push");
   if (shouldPush) {
     core.startGroup("Commit and push diagram");
     await (0, import_exec.exec)("git", ["commit", "-m", commitMessage]);
diff --git a/src/index.jsx b/src/index.jsx
@@ -70,7 +70,7 @@ const main = async () => {
     return
   }
 
-  const shouldPush = core.getBooleanInput('push')
+  const shouldPush = core.getBooleanInput('should_push')
   if (shouldPush) {
     core.startGroup('Commit and push diagram')
     await exec('git', ['commit', '-m', commitMessage])

Original file line number	Diff line number	Diff line change
`@@ -26299,7 +26299,7 @@ var main = async () => {`
`26299`	`26299`	`core.info("[INFO] No changes to the repo detected, exiting");`
`26300`	`26300`	`return;`
`26301`	`26301`	`}`
`26302`		`- const shouldPush = core.getBooleanInput("push");`
	`26302`	`+ const shouldPush = core.getBooleanInput("should_push");`
`26303`	`26303`	`if (shouldPush) {`
`26304`	`26304`	`core.startGroup("Commit and push diagram");`
`26305`	`26305`	`await (0, import_exec.exec)("git", ["commit", "-m", commitMessage]);`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ const main = async () => {`
`70`	`70`	`return`
`71`	`71`	`}`
`72`	`72`
`73`		`- const shouldPush = core.getBooleanInput('push')`
	`73`	`+ const shouldPush = core.getBooleanInput('should_push')`
`74`	`74`	`if (shouldPush) {`
`75`	`75`	`core.startGroup('Commit and push diagram')`
`76`	`76`	`await exec('git', ['commit', '-m', commitMessage])`