Merge pull request #199 from actions/jcambass/2024-09-16/do-not-check-for-action-yml

Do not assume action.yml exists

Author: Jcambass

README.md

@@ -51,7 +51,7 @@ jobs:
       uses: actions/checkout@v4
     - name: Publish
       id: publish
-      uses: actions/publish-immutable-action@0.0.2
+      uses: actions/publish-immutable-action@0.0.3
 ```
 <!-- end usage -->
 

__tests__/fs-helper.test.ts

@@ -24,12 +24,6 @@ describe('stageActionFiles', () => {
     fs.rmSync(stagingDir, { recursive: true })
   })
 
-  it('returns an error if no action.yml file is present', () => {
-    expect(() => fsHelper.stageActionFiles(sourceDir, stagingDir)).toThrow(
-      /^No action.yml or action.yaml file found in source repository/
-    )
-  })
-
   it('copies all files (excluding the .git folder) to the staging directory', () => {
     fs.writeFileSync(`${sourceDir}/action.yml`, fileContent)
 
@@ -50,23 +44,6 @@ describe('stageActionFiles', () => {
     // .git folder is not copied
     expect(fs.existsSync(`${stagingDir}/.git`)).toBe(false)
   })
-
-  it('copies all files (excluding the .git folder) to the staging directory, even if action.yml is in a subdirectory', () => {
-    fs.mkdirSync(`${sourceDir}/my-sub-action`, { recursive: true })
-    fs.writeFileSync(`${sourceDir}/my-sub-action/action.yml`, fileContent)
-
-    fsHelper.stageActionFiles(sourceDir, stagingDir)
-    expect(fs.existsSync(`${stagingDir}/src/main.js`)).toBe(true)
-    expect(fs.existsSync(`${stagingDir}/src/other.js`)).toBe(true)
-    expect(fs.existsSync(`${stagingDir}/my-sub-action/action.yml`)).toBe(true)
-  })
-
-  it('accepts action.yaml as a valid action file as well as action.yml', () => {
-    fs.writeFileSync(`${sourceDir}/action.yaml`, fileContent)
-
-    fsHelper.stageActionFiles(sourceDir, stagingDir)
-    expect(fs.existsSync(`${stagingDir}/action.yaml`)).toBe(true)
-  })
 })
 
 describe('createArchives', () => {

badges/coverage.svg

@@ -91,18 +91,11 @@ export function readFileContents(filePath: string): Buffer {
 }
 
 // Copy actions files from sourceDir to targetDir, excluding the .git folder.
-// Errors if the repo appears to not contain any action files, such as an action.yml file
 export function stageActionFiles(actionDir: string, targetDir: string): void {
-  let actionYmlFound = false
-
   fsExtra.copySync(actionDir, targetDir, {
     filter: (src: string) => {
       const basename = path.basename(src)
 
-      if (basename === 'action.yml' || basename === 'action.yaml') {
-        actionYmlFound = true
-      }
-
       // Filter out the .git folder.
       if (basename === '.git') {
         return false
@@ -111,12 +104,6 @@ export function stageActionFiles(actionDir: string, targetDir: string): void {
       return true
     }
   })
-
-  if (!actionYmlFound) {
-    throw new Error(
-      `No action.yml or action.yaml file found in source repository`
-    )
-  }
 }
 
 // Ensure the correct SHA is checked out for the tag by inspecting the git metadata in the workspace