feat: support description

Author: exuanbo

.github/workflows/test.yml

@@ -50,5 +50,6 @@ jobs:
         with:
           token: ${{ secrets.TOKEN }}
           gist_id: e885afa349a0e5d1cfb408e46d6a37bc
+          gist_description: "foo bar"
           gist_file_name: foo.bar
           file_path: ./__tests__/foo.bar

__tests__/index.test.ts

@@ -5,13 +5,15 @@ import { getInput } from '../src/input'
 
 test('input', () => {
   process.env.INPUT_GIST_ID = 'gist_id'
+  process.env.INPUT_GIST_DESCRIPTION = 'gist_description'
   process.env.INPUT_GIST_FILE_NAME = 'gist_file_name'
   process.env.INPUT_FILE_PATH = 'file_path'
 
   const input = getInput()
 
   expect(input.token).toMatch('')
   expect(input.gistId).toMatch('gist_id')
+  expect(input.gistDescription).toMatch('gist_description')
   expect(input.gistFileName).toMatch('gist_file_name')
   expect(input.filePath).toMatch('file_path')
 })
@@ -20,6 +22,7 @@ test('run', () => {
   process.env.GITHUB_WORKSPACE = process.cwd()
   dotenv.config()
   process.env.INPUT_GIST_ID = 'e885afa349a0e5d1cfb408e46d6a37bc'
+  process.env.INPUT_GIST_DESCRIPTION = 'foo bar'
   process.env.INPUT_GIST_FILE_NAME = 'foo.bar'
   process.env.INPUT_FILE_PATH = '__tests__/foo.bar'
 

action.yml

@@ -11,6 +11,9 @@ inputs:
   gist_id:
     required: true
     description: "Set id of the gist to be updated."
+  gist_description:
+    required: false
+    description: "Set description of the gist."
   gist_file_name:
     required: false
     description: "Set file name in the gist."

dist/index.js

@@ -1,16 +1,18 @@
 import { getInput as getActionInput } from '@actions/core'
 
-interface Input {
-  readonly token: string
-  readonly gistId: string
-  readonly gistFileName?: string
-  readonly filePath: string
-}
+type Input = Readonly<{
+  token: string
+  gistId: string
+  gistDescription?: string
+  gistFileName?: string
+  filePath: string
+}>
 
 export const getInput = (): Input => {
   return {
     token: getActionInput('token'),
     gistId: getActionInput('gist_id'),
+    gistDescription: getActionInput('gist_description'),
     gistFileName: getActionInput('gist_file_name'),
     filePath: getActionInput('file_path')
   }

src/input.ts

@@ -10,6 +10,7 @@ export const run = async (): Promise<void> => {
   startGroup('Dump inputs')
   info(`\
 [INFO] GistId: ${input.gistId}
+[INFO] GistDescription: ${input.gistDescription}
 [INFO] GistFileName: ${input.gistFileName ?? 'No Change'}
 [INFO] FilePath: ${input.filePath}`)
   endGroup()
@@ -26,6 +27,7 @@ export const run = async (): Promise<void> => {
   const fileName = input.gistFileName ?? path.basename(filePath)
   await octokit.rest.gists.update({
     gist_id: input.gistId,
+    description: input.gistDescription,
     files: {
       [fileName]: {
         fileName,