Merge pull request #1 from MechTee/master

Make PDF generation optional and provide markdown

Author: patrixr

README.md

@@ -11,8 +11,11 @@ You need to provide 2 refs to the action, `head` and `base`. The action steps ar
 1. Fetch all the commits between the `head` and `base` refs
 2. Find any reference to JIRA ticket numbers, based on the `jira-code` you provide
 3. Will fetch the ticket titles using the `jira-host`, `jira-username` and `jira-password` you provide
-4. Will generate a pdf with the list of changed tickets, and output the file path under the `pdf` variable
-5. (OPTIONAL) If the `email-to` and `sendgrid-api-key` are provided, and email will be sent with the notes
+4. If `pdf` is set to true:
+   4.1. Will generate a pdf with the list of changed tickets, and output the file path under the `pdf` variable
+otherwise
+   4.2. Will generate markdown with the list of changed tickets, and output it under the `markdown` variable
+6. (OPTIONAL) If the `email-to` and `sendgrid-api-key` are provided, and email will be sent with the notes
 
 ## Credentials: Passwords vs API Tokens
 
@@ -83,6 +86,9 @@ Subject of the release email
 
 Name of the app or service
 
+### pdf
+If set to true, will generate pdf otherwise markdown, default: false
+
 ### unshallow
 
 If set to true, will unshallow the repository before fetching the commits, default: false
@@ -93,6 +99,9 @@ If set to true, will unshallow the repository before fetching the commits, defau
 
 The path of the generated pdf
 
+### `markdown`
+The markdown generated
+
 ## Example usage
 
 ```yaml
@@ -123,8 +132,9 @@ jobs:
         email-to: '[email protected],[email protected]'
         sendgrid-api-key: ${{secrets.sendgrid_api_key}}
         app-name: 'My Awesome Service'
+        pdf: true
         unshallow: true
     - name: Process the pdf
       run: echo "The generated pdf was ${{ steps.pdf_generator.outputs.pdf }}"
 
-```
+```

action.yml

@@ -31,6 +31,10 @@ inputs:
   app-name:
     description: 'Name of the app or service'
     required: false
+  pdf:
+    description: 'If set to true, will return pdf output otherwise will return markdown output'
+    required: false
+    default: false
   unshallow:
     description: 'If set to true, will unshallow the repository before fetching the commits'
     required: false
@@ -43,4 +47,4 @@ branding:
   color: "blue"
 runs:
   using: 'node12'
-  main: 'index.js'
+  main: 'index.js'

index.js

@@ -40,6 +40,7 @@ const options = {
   jiraUsername: readString('jira-username'),
   jiraPassword: readString('jira-password'),
   unshallow: readBoolean('unshallow'),
+  pdf: readBoolean('pdf'),
   emailTo: readString('email-to'),
   emailSubject: readString('email-subject'),
   sendgridApiKey: readString('sendgrid-api-key'),
@@ -48,10 +49,14 @@ const options = {
 
 async function runAction() {
   try {
-    const { pdf } = await execute(options);
-
-    core.setOutput("pdf", pdf);
-    console.log("Generated pdf " + pdf);
+    const result = await execute(options);
+    if (options.pdf) {
+      core.setOutput("pdf", result.pdf);
+      console.log("Generated pdf " + pdf);
+    } else {
+      core.setOutput("markdown", result.markdown);
+      console.log("Generated markdown: " + result.markdown);
+    }
   } catch (e) {
     const message = e && e.message || 'Something went wrong';
     core.setFailed(message);
@@ -62,4 +67,4 @@ if (options.emailTo && !options.sendgridApiKey) {
   core.setFailed('The sendgrid-api-key option is required for sending emails');
 } else {
   runAction();
-}
+}