feat: add upload one artifact per file

Signed-off-by: initdc <initd@outlook.com>

src/constants.ts

@@ -2,7 +2,9 @@ export enum Inputs {
   Name = 'name',
   Path = 'path',
   IfNoFilesFound = 'if-no-files-found',
-  RetentionDays = 'retention-days'
+  RetentionDays = 'retention-days',
+  ArtifactPerFile = 'artifact-per-file',
+  ArtifactNameRule = 'artifact-name-rule'
 }
 
 export enum NoFileOptions {

src/input-helper.ts

@@ -1,14 +1,28 @@
 import * as core from '@actions/core'
 import {Inputs, NoFileOptions} from './constants'
-import {UploadInputs} from './upload-inputs'
+import {UploadInputs, UploadPerFile} from './upload-inputs'
 
 /**
  * Helper to get all the inputs for the action
  */
-export function getInputs(): UploadInputs {
-  const name = core.getInput(Inputs.Name)
-  const path = core.getInput(Inputs.Path, {required: true})
+export function getInputs(): UploadInputs | UploadPerFile {
+  const TRUE_MAP = ['true', 'True', 'TRUE']
 
+  let artifactPerFile = false
+  const artifactPerFileStr = core.getInput(Inputs.ArtifactPerFile)
+  if (artifactPerFileStr) {
+    artifactPerFile = TRUE_MAP.includes(artifactPerFileStr) ? true : false
+  }
+
+  let name = ''
+  let artifactNameRule = ''
+  if (!artifactPerFile) {
+    name = core.getInput(Inputs.Name)
+  } else {
+    artifactNameRule = core.getInput(Inputs.ArtifactNameRule) || '${base}'
+  }
+
+  const path = core.getInput(Inputs.Path, {required: true})
   const ifNoFilesFound = core.getInput(Inputs.IfNoFilesFound)
   const noFileBehavior: NoFileOptions = NoFileOptions[ifNoFilesFound]
 
@@ -22,19 +36,44 @@ export function getInputs(): UploadInputs {
     )
   }
 
-  const inputs = {
-    artifactName: name,
-    searchPath: path,
-    ifNoFilesFound: noFileBehavior
-  } as UploadInputs
+  const typedInputs = (
+    artifactPerFile: boolean
+  ): UploadInputs | UploadPerFile => {
+    const retentionDaysStr = core.getInput(Inputs.RetentionDays)
 
-  const retentionDaysStr = core.getInput(Inputs.RetentionDays)
-  if (retentionDaysStr) {
-    inputs.retentionDays = parseInt(retentionDaysStr)
-    if (isNaN(inputs.retentionDays)) {
-      core.setFailed('Invalid retention-days')
+    if (!artifactPerFile) {
+      const inputs = {
+        artifactsName: name,
+        searchPath: path,
+        ifNoFilesFound: noFileBehavior
+      } as UploadInputs
+
+      if (retentionDaysStr) {
+        inputs.retentionDays = parseInt(retentionDaysStr)
+        if (isNaN(inputs.retentionDays)) {
+          core.setFailed('Invalid retention-days')
+        }
+      }
+
+      return inputs
+    } else {
+      const inputs = {
+        searchPath: path,
+        ifNoFilesFound: noFileBehavior,
+        artifactPerFile: artifactPerFile,
+        artifactNameRule: artifactNameRule
+      } as UploadPerFile
+
+      if (retentionDaysStr) {
+        inputs.retentionDays = parseInt(retentionDaysStr)
+        if (isNaN(inputs.retentionDays)) {
+          core.setFailed('Invalid retention-days')
+        }
+      }
+
+      return inputs
     }
   }
 
-  return inputs
+  return typedInputs(artifactPerFile)
 }

src/upload-artifact.ts

@@ -3,10 +3,12 @@ import {create, UploadOptions} from '@actions/artifact'
 import {findFilesToUpload} from './search'
 import {getInputs} from './input-helper'
 import {NoFileOptions} from './constants'
+import {UploadInputs, UploadPerFile} from './upload-inputs'
+import path from 'path'
 
 async function run(): Promise<void> {
   try {
-    const inputs = getInputs()
+    const inputs: UploadInputs | UploadPerFile = getInputs()
     const searchResult = await findFilesToUpload(inputs.searchPath)
     if (searchResult.filesToUpload.length === 0) {
       // No files were found, different use cases warrant different types of behavior if nothing is found
@@ -51,21 +53,85 @@ async function run(): Promise<void> {
         options.retentionDays = inputs.retentionDays
       }
 
-      const uploadResponse = await artifactClient.uploadArtifact(
-        inputs.artifactName,
-        searchResult.filesToUpload,
-        searchResult.rootDirectory,
-        options
-      )
+      const artifactsName = inputs['artifactsName'] || 'artifacts'
+      const artifactPerFile = inputs['artifactPerFile'] || false
+      if (!artifactPerFile) {
+        const uploadResponse = await artifactClient.uploadArtifact(
+          artifactsName,
+          searchResult.filesToUpload,
+          searchResult.rootDirectory,
+          options
+        )
 
-      if (uploadResponse.failedItems.length > 0) {
-        core.setFailed(
-          `An error was encountered when uploading ${uploadResponse.artifactName}. There were ${uploadResponse.failedItems.length} items that failed to upload.`
-        )
+        if (uploadResponse.failedItems.length > 0) {
+          core.setFailed(
+            `An error was encountered when uploading ${uploadResponse.artifactName}. There were ${uploadResponse.failedItems.length} items that failed to upload.`
+          )
+        } else {
+          core.info(
+            `Artifact ${uploadResponse.artifactName} has been successfully uploaded!`
+          )
+        }
       } else {
-        core.info(
-          `Artifact ${uploadResponse.artifactName} has been successfully uploaded!`
-        )
+        const filesToUpload = searchResult.filesToUpload
+        const SuccessedItems: string[] = []
+        const FailedItems: string[] = []
+
+        const artifactNameRule = inputs['artifactNameRule']
+        for (let i = 0; i < filesToUpload.length; i++) {
+          const file = filesToUpload[i]
+          core.info(file)
+
+          const pathObject = path.parse(file)
+          let artifactName = artifactNameRule
+          for (const key of Object.keys(pathObject)) {
+            const re = `$\{${key}}`
+            if (artifactNameRule.includes(re)) {
+              const value = pathObject[key] || ''
+              artifactName = artifactName.replace(re, value)
+            }
+          }
+          if (artifactName.includes(path.sep)) {
+            core.warning(`${artifactName} includes ${path.sep}`)
+            artifactName = artifactName.split(path.sep).join('_')
+          }
+          if (artifactName.includes(':')) {
+            core.warning(`${artifactName} includes :`)
+            artifactName = artifactName.split(':').join('-')
+          }
+          core.info(artifactName)
+
+          const artifactItemExist = SuccessedItems.includes(artifactName)
+          if (artifactItemExist) {
+            const oldArtifactName = artifactName
+            core.warning(`${artifactName} artifact alreay exist`)
+            artifactName = `${i}__${artifactName}`
+            core.warning(`${oldArtifactName} => ${artifactName}`)
+          }
+
+          const uploadResponse = await artifactClient.uploadArtifact(
+            artifactName,
+            [file],
+            searchResult.rootDirectory,
+            options
+          )
+          if (uploadResponse.failedItems.length > 0) {
+            FailedItems.push(artifactName)
+          } else {
+            SuccessedItems.push(artifactName)
+          }
+        }
+
+        if (FailedItems.length > 0) {
+          let errMsg = `${FailedItems.length} artifacts failed to upload, they were:\n`
+          errMsg += FailedItems.join('\n')
+          core.setFailed(errMsg)
+        }
+        if (SuccessedItems.length > 0) {
+          let infoMsg = `${SuccessedItems.length} artifacts has been successfully uploaded! They were:\n`
+          infoMsg += SuccessedItems.join('\n')
+          core.info(infoMsg)
+        }
       }
     }
   } catch (err) {

src/upload-inputs.ts

@@ -4,7 +4,7 @@ export interface UploadInputs {
   /**
    * The name of the artifact that will be uploaded
    */
-  artifactName: string
+  artifactsName: string
 
   /**
    * The search path used to describe what to upload as part of the artifact
@@ -21,3 +21,20 @@ export interface UploadInputs {
    */
   retentionDays: number
 }
+
+export interface UploadPerFile {
+  searchPath: string
+  ifNoFilesFound: NoFileOptions
+  retentionDays: number
+
+  // artifact-per-file: {true | false}
+  // @default: false
+  artifactPerFile: boolean
+
+  // https://nodejs.org/docs/latest-v16.x/api/path.html#pathparsepath
+  // @args: searchResult.filesToUpload
+  // @return: String.replace()
+  // @default: pathObject.base
+  // @default rule: "${base}"
+  artifactNameRule: string
+}