diff --git a/README.md b/README.md
index ba465c49..43ba4fa3 100644
--- a/README.md
+++ b/README.md
@@ -282,6 +282,7 @@ As seen above, we have two steps. One for a noop deploy, and one for a regular d
| `merge_deploy_mode` | `false` | `"false"` | Advanced configuration option for operations on merge commits. See the [merge commit docs](#merge-commit-workflow-strategy) below |
| `unlock_on_merge_mode` | `false` | `"false"` | Advanced configuration option for automatically releasing locks associated with a pull request when that pull request is merged. See the [unlock on merge mode](docs/unlock-on-merge.md) documentation for more details |
| `skip_completing` | `false` | `"false"` | If set to "true", skip the process of completing a deployment. You must manually create a deployment status after the deployment is complete. Default is "false" |
+| `deploy_message_path` | `false` | `".github/deployment_message.md"` | The path to a markdown file which is used as a template for custom deployment messages. Example: `".github/deployment_message.md"` |
## Outputs π€
diff --git a/__tests__/functions/check-input.test.js b/__tests__/functions/check-input.test.js
new file mode 100644
index 00000000..efd7fe6f
--- /dev/null
+++ b/__tests__/functions/check-input.test.js
@@ -0,0 +1,23 @@
+import {checkInput} from '../../src/functions/check-input'
+
+test('checks an input an finds that it is valid', async () => {
+ expect(await checkInput('production')).toStrictEqual('production')
+})
+
+test('checks an input an finds that it is valid with true/false strings', async () => {
+ expect(await checkInput('true')).toStrictEqual('true')
+
+ expect(await checkInput('false')).toStrictEqual('false')
+})
+
+test('checks an empty string input an finds that it is invalid', async () => {
+ expect(await checkInput('')).toStrictEqual(null)
+})
+
+test('checks a null object input an finds that it is invalid', async () => {
+ expect(await checkInput(null)).toStrictEqual(null)
+})
+
+test('checks a string of null input an finds that it is invalid', async () => {
+ expect(await checkInput('null')).toStrictEqual(null)
+})
diff --git a/__tests__/functions/post-deploy-message.test.js b/__tests__/functions/post-deploy-message.test.js
new file mode 100644
index 00000000..59ceb733
--- /dev/null
+++ b/__tests__/functions/post-deploy-message.test.js
@@ -0,0 +1,183 @@
+import {postDeployMessage} from '../../src/functions/post-deploy-message'
+import * as core from '@actions/core'
+import dedent from 'dedent-js'
+
+// const debugMock = jest.spyOn(core, 'debug')
+
+var context
+var environment
+var environment_url
+var environment_url_simple
+var status
+var noop
+var ref
+
+beforeEach(() => {
+ jest.clearAllMocks()
+ jest.spyOn(core, 'info').mockImplementation(() => {})
+ jest.spyOn(core, 'debug').mockImplementation(() => {})
+
+ process.env.DEPLOY_MESSAGE = null
+ process.env.INPUT_ENVIRONMENT_URL_IN_COMMENT = 'true'
+ process.env.INPUT_DEPLOY_MESSAGE_PATH = '.github/deployment_message.md'
+
+ environment = 'production'
+ environment_url = 'https://example.com'
+ environment_url_simple = 'example.com'
+ status = 'success'
+ noop = false
+ ref = 'test-ref'
+
+ context = {
+ actor: 'monalisa',
+ eventName: 'issue_comment',
+ workflow: 'test-workflow',
+ repo: {
+ owner: 'corp',
+ repo: 'test'
+ },
+ payload: {
+ comment: {
+ id: '1'
+ }
+ }
+ }
+})
+
+test('successfully constructs a post deploy message with the defaults', async () => {
+ expect(
+ await postDeployMessage(
+ context, // context
+ environment, // environment
+ environment_url, // environment_url
+ status, // status
+ noop, // noop
+ ref // ref
+ )
+ ).toStrictEqual(
+ dedent(`
+ ### Deployment Results β
+
+ **${context.actor}** successfully deployed branch \`${ref}\` to **${environment}**
+
+ > **Environment URL:** [${environment_url_simple}](${environment_url})`)
+ )
+})
+
+test('successfully constructs a post deploy message with the defaults during a "noop" deploy', async () => {
+ expect(
+ await postDeployMessage(
+ context, // context
+ environment, // environment
+ environment_url, // environment_url
+ status, // status
+ true, // noop
+ ref // ref
+ )
+ ).toStrictEqual(
+ dedent(`
+ ### Deployment Results β
+
+ **${context.actor}** successfully **noop** deployed branch \`${ref}\` to **${environment}**`)
+ )
+})
+
+test('successfully constructs a post deploy message with the defaults during a deployment failure', async () => {
+ expect(
+ await postDeployMessage(
+ context, // context
+ environment, // environment
+ environment_url, // environment_url
+ 'failure', // status
+ noop, // noop
+ ref // ref
+ )
+ ).toStrictEqual(
+ dedent(`
+ ### Deployment Results β
+
+ **${context.actor}** had a failure when deploying branch \`${ref}\` to **${environment}**`)
+ )
+})
+
+test('successfully constructs a post deploy message with the defaults during a deployment with an unknown status', async () => {
+ expect(
+ await postDeployMessage(
+ context, // context
+ environment, // environment
+ environment_url, // environment_url
+ 'unknown', // status
+ noop, // noop
+ ref // ref
+ )
+ ).toStrictEqual(
+ dedent(`
+ ### Deployment Results β οΈ
+
+ Warning: deployment status is unknown, please use caution`)
+ )
+})
+
+test('successfully constructs a post deploy message with a custom env var', async () => {
+ process.env.DEPLOY_MESSAGE = 'Deployed 1 shiny new server'
+
+ expect(
+ await postDeployMessage(
+ context, // context
+ environment, // environment
+ environment_url, // environment_url
+ status, // status
+ noop, // noop
+ ref // ref
+ )
+ ).toStrictEqual(
+ dedent(`
+ ### Deployment Results β
+
+ **${context.actor}** successfully deployed branch \`${ref}\` to **${environment}**
+
+ Show Results
+
+ Deployed 1 shiny new server
+
+ Show Results
\n\n Deployment has created 1 new server\n\n Show Results
\n\n Deployment has created 1 new server\n\n Show Results
\n\n Deployment has created 1 new server\n\n Show Results
\n\n Deployment has created 1 new server\n\n