Merge pull request #283 from crs-k/documentation-cleanup

documentation cleanup

README.md

@@ -32,6 +32,7 @@ Inputs are defined in [`action.yml`](action.yml):
 | `days-before-delete` | `No` | Number of days a branch has been inactive before it is deleted. | 180 days |
 | `comment-updates` | `No` | If this is enabled, a comment with updated information will be added to existing issues each workflow run. | false |
 | `max-issues` | `No` | This is the maximum number of branches that this action will assess per workflow run. | 20 |
+| `tag-committer` | `No` | When an issue is opened, this will tag the stale branchs last committer in the comments. | false |
 
 ### Outputs
 Outputs are defined in [`action.yml`](action.yml):

__tests__/functions/create-issue.test.ts

@@ -15,13 +15,13 @@ let lastCommitter = 'crs-k'
 
 describe('Create Issue Function', () => {
   test('createIssue endpoint is called with tag committer enabled', async () => {
-    Object.defineProperty(context, 'tagLastComitter', {value: true})
+    Object.defineProperty(context, 'tagLastCommitter', {value: true})
     await createIssue(branchName, commitAge, lastCommitter)
     expect(github.rest.issues.create).toHaveBeenCalled()
   })
 
   test('createIssue endpoint is called with tag committer disabled', async () => {
-    Object.defineProperty(context, 'tagLastComitter', {value: false})
+    Object.defineProperty(context, 'tagLastCommitter', {value: false})
     await createIssue(branchName, commitAge, lastCommitter)
     expect(github.rest.issues.create).toHaveBeenCalled()
   })

__tests__/functions/update-issue.test.ts

@@ -17,14 +17,14 @@ let lastCommitter = 'crs-k'
 describe('Get Commits Function', () => {
   test('updateIssue endpoint is called with tag committer enabled', async () => {
     Object.defineProperty(context, 'commentUpdates', {value: true})
-    Object.defineProperty(context, 'tagLastComitter', {value: true})
+    Object.defineProperty(context, 'tagLastCommitter', {value: true})
     await updateIssue(issueNumber, branchName, commitAge, lastCommitter)
     expect(github.rest.issues.createComment).toHaveBeenCalled()
   })
 
   test('updateIssue endpoint is called with tag committer disabled', async () => {
     Object.defineProperty(context, 'commentUpdates', {value: true})
-    Object.defineProperty(context, 'tagLastComitter', {value: false})
+    Object.defineProperty(context, 'tagLastCommitter', {value: false})
     await updateIssue(issueNumber, branchName, commitAge, lastCommitter)
     expect(github.rest.issues.createComment).toHaveBeenCalled()
   })

action.yml

@@ -21,7 +21,7 @@ inputs:
     required: false
     default: '20'
   tag-committer:
-    description: 'When an issue is opened, this will tag the stale branchs last comitter in the comments.'
+    description: 'When an issue is opened, this will tag the stale branchs last committer in the comments.'
     required: false
     default: false
 outputs:
@@ -33,5 +33,5 @@ runs:
   using: 'node12'
   main: 'dist/index.js'
 branding:
-  icon: 'save'
+  icon: 'delete'
   color: 'blue'

src/functions/create-issue.ts

@@ -1,6 +1,6 @@
 import * as assert from 'assert'
 import * as core from '@actions/core'
-import {daysBeforeDelete, github, owner, repo, tagLastComitter} from './get-context'
+import {daysBeforeDelete, github, owner, repo, tagLastCommitter} from './get-context'
 
 export async function createIssue(
   branch: string,
@@ -11,7 +11,7 @@ export async function createIssue(
   let bodyString: string
   const daysUntilDelete = Math.max(0, daysBeforeDelete - commitAge)
 
-  switch (tagLastComitter) {
+  switch (tagLastCommitter) {
     case true:
       bodyString = `@${lastCommitter}, \r \r ${branch} has had no activity for ${commitAge.toString()} days. \r \r This branch will be automatically deleted in ${daysUntilDelete.toString()} days.`
       break

src/functions/get-context.ts

@@ -9,4 +9,4 @@ export const daysBeforeStale = Number(core.getInput('days-before-stale', {requir
 export const daysBeforeDelete = Number(core.getInput('days-before-delete', {required: false}))
 export const commentUpdates = core.getBooleanInput('comment-updates', {required: false})
 export const maxIssues = Number(core.getInput('max-issues', {required: false}))
-export const tagLastComitter = core.getBooleanInput('tag-committer', {required: false})
+export const tagLastCommitter = core.getBooleanInput('tag-committer', {required: false})

src/functions/update-issue.ts

@@ -1,6 +1,13 @@
 import * as assert from 'assert'
 import * as core from '@actions/core'
-import {commentUpdates, daysBeforeDelete, github, owner, repo, tagLastComitter} from './get-context'
+import {
+  commentUpdates,
+  daysBeforeDelete,
+  github,
+  owner,
+  repo,
+  tagLastCommitter
+} from './get-context'
 
 export async function updateIssue(
   issueNumber: number,
@@ -14,7 +21,7 @@ export async function updateIssue(
   const daysUntilDelete = Math.max(0, daysBeforeDelete - commitAge)
 
   if (commentUpdates === true) {
-    switch (tagLastComitter) {
+    switch (tagLastCommitter) {
       case true:
         bodyString = `@${lastCommitter}, \r \r ${branch} has had no activity for ${commitAge.toString()} days. \r \r This branch will be automatically deleted in ${daysUntilDelete.toString()} days. \r \r This issue was last updated on ${new Date().toString()}`
         break