✨ Add PR_BODY option (#80)

This commit adds a PR body input to the action, that can be used to add additional text to the PR description. This is useful when trying the explain more about the PR such as the cause behind its creation and how the future changes will lead to a forced push instead of a new PR.

Originally discussed in #78.

* Add a PR body input for the action

* Add the `PR_BODY` variable to the context

* Use `PR_BODY` in the PR body

* Replace array with string

* Move the PR body aboved the changed files

action.yml

@@ -15,6 +15,10 @@ inputs:
     description: |
       Labels which will be added to the pull request. Defaults to sync. Set to false to turn off
     required: false
+  PR_BODY:
+    description: |
+      Additional content to add in the PR description. Defaults to ''
+    required: false
   ASSIGNEES:
     description: |
       People to assign to the pull request. Defaults to none

src/config.js

@@ -44,6 +44,10 @@ try {
 			type: 'array',
 			disableable: true
 		}),
+		PR_BODY: getInput({
+			key: 'PR_BODY',
+			default: ''
+		}),
 		ASSIGNEES: getInput({
 			key: 'ASSIGNEES',
 			type: 'array'
@@ -209,4 +213,4 @@ const parseConfig = async () => {
 module.exports = {
 	...context,
 	parseConfig
-}
+}

src/git.js

@@ -13,6 +13,7 @@ const {
 	COMMIT_PREFIX,
 	GITHUB_REPOSITORY,
 	OVERWRITE_EXISTING_PR,
+	PR_BODY,
 	BRANCH_PREFIX
 } = require('./config')
 
@@ -194,6 +195,8 @@ class Git {
 		const body = dedent(`
 			Synced local file(s) with [${ GITHUB_REPOSITORY }](https://github.com/${ GITHUB_REPOSITORY }).
 
+			${ PR_BODY }
+			
 			${ changedFiles }
 
 			---
@@ -249,4 +252,4 @@ class Git {
 	}
 }
 
-module.exports = Git
+module.exports = Git