Merge pull request #3 from NejcZdovc/file-input

Adds file input support

Author: NejcZdovc

.github/workflows/comment.md

@@ -0,0 +1,3 @@
+# hi user
+
+Current time is {DATE}!

.github/workflows/example.yml

@@ -4,15 +4,48 @@ on:
   pull_request:
 
 jobs:
-  example:
-    name: Example
+  body:
+    name: Doing comment with message
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
       uses: actions/checkout@v2
+
+    - name: Get time
+      uses: actions/github-script@v3
+      id: get-time
+      with:
+        script: return new Date().toString()
+        result-encoding: string
+
+    - name: Comment
+      uses: ./
+      with:
+        message: >
+          Hello world :wave:!
+          ${{steps.get-time.outputs.result}}
+        identifier: 'GITHUB_COMMIT_BODY'
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+  file:
+    name: Doing comment with file
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Get time
+      uses: actions/github-script@v3
+      id: get-time
+      with:
+        script: return new Date().toString()
+        result-encoding: string
+
     - name: Comment
       uses: ./
       with:
-        message: "Hello world :wave:!"
+        file: 'comment.md'
+        identifier: 'GITHUB_COMMIT_FILE'
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        DATE: ${{steps.get-time.outputs.result}}

README.md

@@ -8,11 +8,14 @@ You can do multiple comments during the workflow execution via different identif
 
 | Name | Description | Required | Default |
 | ---- | ----------- | -------- | ------- |
-| message | Message that you want in the comment (markdown supported) | yes | |
+| message | Message that you want in the comment (markdown supported) | message or file | |
+| file | File name of the message (file needs to be placed in `.github/workflows/`) | message or file | |
 | single_comment | Would you like to update existing comment (if exists) instead of creating new one every time? | no | true |
 | identifier | Identifier that we put as comment in the comment, so that we can identify them | no | `GITHUB_ACTION_COMMENT_PR` |
 | github_token | Github token that we use to create/update commit | yes | |
 
+It's required to provide `message` or `file` input. If both are provided `message` input will be used.
+
 ## Output
 
 | Name | Description | Return |
@@ -30,6 +33,35 @@ env:
   GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 ```
 
+### Simple comment via file
+```yaml
+uses: NejcZdovc/comment-pr@v1
+with:
+  file: "comment.md"
+env:
+  GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+```
+
+File should be placed in `.github/workflows` and it should be `.md`.
+
+### Passing data in md file
+
+```yaml
+uses: NejcZdovc/comment-pr@v1
+with:
+  file: "comment.md"
+env:
+  GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+  DATA: 'year 2020'
+```
+When you need to pass data from workflow info file you just define new env variable.
+That will be automatically replaced in the template.
+
+Example of `comment.md` that uses `DATA` env variable.
+```md
+It's almost end of {DATA}!
+```
+
 
 ### Multiple comments
 With specifying different `identifier` per step we will now track two different comments, and they will be updated accordingly.

action.yml

@@ -4,7 +4,8 @@ description: 'Add comments in the PR with your GitHub Actions workflow.'
 inputs:
   message:
     description: 'Message for the PR'
-    required: true
+  file:
+    description: 'Name for comment md file'
   single_comment:
     description: 'Would you only like one comment from the action in the PR?'
     default: 'true'

dist/index.js

@@ -11,9 +11,12 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _actions_github__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(_actions_github__WEBPACK_IMPORTED_MODULE_0__);
 
 const core = __webpack_require__(186)
+const { promises: fs } = __webpack_require__(747)
+const path = __webpack_require__(622)
 
 const getInputs = () => ({
   message: core.getInput('message'),
+  file: core.getInput('file'),
   singleComment: core.getInput('single_comment') === 'true',
   identifier: core.getInput('identifier'),
   githubToken: core.getInput('github_token') || process.env.GITHUB_TOKEN
@@ -27,9 +30,44 @@ const getIdentifier = () => {
   return `<!-- ${identifier} -->`
 }
 
-const getMessage = () => {
+const getFileContent = async () => {
+  const { file } = getInputs()
+
+  if (!file) {
+    return null
+  }
+
+  const filePath = path.join(__dirname, `../.github/workflows/${file}`)
+  const content = await fs.readFile(filePath, 'utf8')
+  if (!content) {
+    return null
+  }
+
+  return content.replace(/{\w+}/g, (key) => {
+    const envKey = key.substring(1, key.length - 1)
+    if (process.env[envKey]) {
+      return process.env[envKey]
+    }
+
+    return key
+  })
+}
+
+const getMessage = async () => {
   const { message } = getInputs()
-  return `${getIdentifier()}\n${message}`
+
+  let body
+  if (!message) {
+    body = await getFileContent()
+  } else {
+    body = message
+  }
+
+  if (!body) {
+    throw new Error('You need to provide message or file input')
+  }
+
+  return `${getIdentifier()}\n${body}`
 }
 
 const findComment = async (client) => {
@@ -76,9 +114,7 @@ const comment = async (client) => {
     commentId = await findComment(client)
   }
 
-  console.log(commentId)
-
-  const body = getMessage()
+  const body = await getMessage()
   if (commentId) {
     await client.issues
       .updateComment({

index.js

@@ -1,8 +1,11 @@
 import { context, getOctokit } from '@actions/github'
 const core = require('@actions/core')
+const { promises: fs } = require('fs')
+const path = require('path')
 
 const getInputs = () => ({
   message: core.getInput('message'),
+  file: core.getInput('file'),
   singleComment: core.getInput('single_comment') === 'true',
   identifier: core.getInput('identifier'),
   githubToken: core.getInput('github_token') || process.env.GITHUB_TOKEN
@@ -16,9 +19,44 @@ const getIdentifier = () => {
   return `<!-- ${identifier} -->`
 }
 
-const getMessage = () => {
+const getFileContent = async () => {
+  const { file } = getInputs()
+
+  if (!file) {
+    return null
+  }
+
+  const filePath = path.join(__dirname, `../.github/workflows/${file}`)
+  const content = await fs.readFile(filePath, 'utf8')
+  if (!content) {
+    return null
+  }
+
+  return content.replace(/{\w+}/g, (key) => {
+    const envKey = key.substring(1, key.length - 1)
+    if (process.env[envKey]) {
+      return process.env[envKey]
+    }
+
+    return key
+  })
+}
+
+const getMessage = async () => {
   const { message } = getInputs()
-  return `${getIdentifier()}\n${message}`
+
+  let body
+  if (!message) {
+    body = await getFileContent()
+  } else {
+    body = message
+  }
+
+  if (!body) {
+    throw new Error('You need to provide message or file input')
+  }
+
+  return `${getIdentifier()}\n${body}`
 }
 
 const findComment = async (client) => {
@@ -65,9 +103,7 @@ const comment = async (client) => {
     commentId = await findComment(client)
   }
 
-  console.log(commentId)
-
-  const body = getMessage()
+  const body = await getMessage()
   if (commentId) {
     await client.issues
       .updateComment({