linting

.github/workflows/publish-immutable-actions.yml

@@ -1,20 +0,0 @@
-name: 'Publish Immutable Action Version'
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-      packages: write
-
-    steps:
-      - name: Checking out
-        uses: actions/checkout@v4
-      - name: Publish
-        id: publish
-        uses: actions/publish-immutable-action@0.0.3

.github/workflows/test.yml

@@ -46,19 +46,14 @@ jobs:
     - name: Test
       run: npm run test
 
-    # Test end-to-end by uploading a few artifacts and then downloading them
+    # Test end-to-end by uploading two artifacts and then downloading them
     - name: Create artifact files
       run: |
         mkdir -p path/to/dir-1
         mkdir -p path/to/dir-2
         mkdir -p path/to/dir-3
-        mkdir -p symlink/
         echo "Lorem ipsum dolor sit amet" > path/to/dir-1/file1.txt
         echo "Hello world from file #2" > path/to/dir-2/file2.txt
-        echo "Hello from a symlinked file" > symlink/original.txt
-        ln -s $(pwd)/symlink/original.txt symlink/abs.txt
-        ln -s original.txt symlink/rel.txt
-      shell: bash
 
     # Upload a single file artifact
     - name: 'Upload artifact #1'
@@ -84,14 +79,6 @@ jobs:
           path/to/dir-[23]/*
           !path/to/dir-3/*.txt
 
-    - name: 'Upload symlinked artifact'
-      uses: ./
-      with:
-        name: 'Symlinked-Artifact-${{ matrix.runs-on }}'
-        path: |
-          symlink/abs.txt
-          symlink/rel.txt
-
     # Download Artifact #1 and verify the correctness of the content
     - name: 'Download artifact #1'
       uses: actions/download-artifact@v4
@@ -154,34 +141,6 @@ jobs:
         }
       shell: pwsh
 
-    - name: 'Download symlinked artifact'
-      uses: actions/download-artifact@v4
-      with:
-        name: 'Symlinked-Artifact-${{ matrix.runs-on }}'
-        path: from/symlink
-
-    - name: 'Verify symlinked artifact'
-      run: |
-        $abs = "from/symlink/abs.txt"
-        if(!(Test-Path -path $abs))
-        {
-            Write-Error "Expected file does not exist"
-        }
-        if(!((Get-Content $abs) -ceq "Hello from a symlinked file"))
-        {
-            Write-Error "File contents of downloaded artifact are incorrect"
-        }
-        $rel = "from/symlink/rel.txt"
-        if(!(Test-Path -path $rel))
-        {
-            Write-Error "Expected file does not exist"
-        }
-        if(!((Get-Content $rel) -ceq "Hello from a symlinked file"))
-        {
-            Write-Error "File contents of downloaded artifact are incorrect"
-        }
-      shell: pwsh
-
     - name: 'Alter file 1 content'
       run: |
         echo "This file has changed" > path/to/dir-1/file1.txt

.licenses/npm/@actions/artifact.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: "@actions/artifact"
-version: 2.1.11
+version: 2.1.8
 type: npm
 summary: 
 homepage: 

.licenses/npm/@actions/core.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: "@actions/core"
-version: 1.11.1
+version: 1.10.1
 type: npm
 summary: 
 homepage: 

.licenses/npm/@actions/glob.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: "@actions/glob"
-version: 0.5.0
+version: 0.3.0
 type: npm
 summary: 
 homepage: 

README.md

@@ -16,6 +16,7 @@ See also [download-artifact](https://github.com/actions/download-artifact).
     - [Breaking Changes](#breaking-changes)
   - [Usage](#usage)
     - [Inputs](#inputs)
+      - [Uploading the `.git` directory](#uploading-the-git-directory)
     - [Outputs](#outputs)
   - [Examples](#examples)
     - [Upload an Individual File](#upload-an-individual-file)
@@ -64,7 +65,7 @@ There is also a new sub-action, `actions/upload-artifact/merge`. For more info,
     Due to how Artifacts are created in this new version, it is no longer possible to upload to the same named Artifact multiple times. You must either split the uploads into multiple Artifacts with different names, or only upload once. Otherwise you _will_ encounter an error.
 
 3. Limit of Artifacts for an individual job. Each job in a workflow run now has a limit of 500 artifacts.
-4. With `v4.4` and later, hidden files are excluded by default.
+4. With `v4.4` and later, the `.git` directory is excluded by default.
 
 For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
 
@@ -108,12 +109,30 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
     # Does not fail if the artifact does not exist.
     # Optional. Default is 'false'
     overwrite:
+```
 
-    # Whether to include hidden files in the provided path in the artifact
+#### Uploading the `.git` directory
-    # The file contents of any hidden files in the path should be validated before
+
-    # enabled this to avoid uploading sensitive information.
+By default, files in a `.git` directory are ignored in the uploaded artifact.
-    # Optional. Default is 'false'
+This is intended to prevent accidentally uploading Git credentials into an artifact that could then
-    include-hidden-files:
+be extracted.
+If files in the `.git` directory are needed, ensure that `actions/checkout` is being used with
+`persist-credentials: false`.
+
+```yaml
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false # Ensure credentials are not saved in `.git/config`
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: .
+          include-git-directory: true
 ```
 
 ### Outputs
@@ -417,28 +436,6 @@ jobs:
           overwrite: true
 ```
 
-### Uploading Hidden Files
-
-By default, hidden files are ignored by this action to avoid unintentionally uploading sensitive information.
-
-If you need to upload hidden files, you can use the `include-hidden-files` input.
-Any files that contain sensitive information that should not be in the uploaded artifact can be excluded
-using the `path`:
-
-```yaml
-- uses: actions/upload-artifact@v4
-  with:
-    name: my-artifact
-    include-hidden-files: true
-    path: |
-      path/output/
-      !path/output/.production.env
-```
-
-Hidden files are defined as any file beginning with `.` or files within folders beginning with `.`.
-On Windows, files and directories with the hidden attribute are not considered hidden files unless
-they have the `.` prefix.
-
 ## Limitations
 
 ### Number of Artifacts

__tests__/search.test.ts

@@ -61,19 +61,11 @@ const lonelyFilePath = path.join(
   'lonely-file.txt'
 )
 
-const hiddenFile = path.join(root, '.hidden-file.txt')
+const gitConfigPath = path.join(root, '.git', 'config')
-const fileInHiddenFolderPath = path.join(
+const gitHeadPath = path.join(root, '.git', 'HEAD')
-  root,
+
-  '.hidden-folder',
+const nestedGitConfigPath = path.join(root, 'repository-name', '.git', 'config')
-  'folder-in-hidden-folder',
+const nestedGitHeadPath = path.join(root, 'repository-name', '.git', 'HEAD')
-  'file.txt'
-)
-const fileInHiddenFolderInFolderA = path.join(
-  root,
-  'folder-a',
-  '.hidden-folder-in-folder-a',
-  'file.txt'
-)
 
 describe('Search', () => {
   beforeAll(async () => {
@@ -107,11 +99,8 @@ describe('Search', () => {
       recursive: true
     })
 
-    await fs.mkdir(
+    await fs.mkdir(path.join(root, '.git'))
-      path.join(root, '.hidden-folder', 'folder-in-hidden-folder'),
+    await fs.mkdir(path.join(root, 'repository-name', '.git'), {
-      {recursive: true}
-    )
-    await fs.mkdir(path.join(root, 'folder-a', '.hidden-folder-in-folder-a'), {
       recursive: true
     })
 
@@ -133,18 +122,17 @@ describe('Search', () => {
 
     await fs.writeFile(lonelyFilePath, 'all by itself')
 
-    await fs.writeFile(hiddenFile, 'hidden file')
+    await fs.writeFile(gitConfigPath, 'git config file')
-    await fs.writeFile(fileInHiddenFolderPath, 'file in hidden directory')
+    await fs.writeFile(gitHeadPath, 'git head file')
-    await fs.writeFile(fileInHiddenFolderInFolderA, 'file in hidden directory')
+    await fs.writeFile(nestedGitConfigPath, 'nested git config file')
+    await fs.writeFile(nestedGitHeadPath, 'nested git head file')
     /*
       Directory structure of files that get created:
       root/
-          .hidden-folder/
+          .git/
-              folder-in-hidden-folder/
+              config
-                  file.txt
+              HEAD
           folder-a/
-              .hidden-folder-in-folder-a/
-                  file.txt
               folder-b/
                   folder-c/
                       search-item1.txt
@@ -167,7 +155,10 @@ describe('Search', () => {
               folder-j/
                   folder-k/
                       lonely-file.txt
-          .hidden-file.txt
+          repository-name/
+            .git/
+                config
+                HEAD
           search-item5.txt
     */
   })
@@ -385,23 +376,17 @@ describe('Search', () => {
     expect(searchResult.filesToUpload.includes(lonelyFilePath)).toEqual(true)
   })
 
-  it('Hidden files ignored by default', async () => {
+  it('Excludes .git directory by default', async () => {
-    const searchPath = path.join(root, '**/*')
+    const searchResult = await findFilesToUpload(root)
-    const searchResult = await findFilesToUpload(searchPath)
+    expect(searchResult.filesToUpload.length).toEqual(13)
-
+    expect(searchResult.filesToUpload).not.toContain(gitConfigPath)
-    expect(searchResult.filesToUpload).not.toContain(hiddenFile)
-    expect(searchResult.filesToUpload).not.toContain(fileInHiddenFolderPath)
-    expect(searchResult.filesToUpload).not.toContain(
-      fileInHiddenFolderInFolderA
-    )
   })
 
-  it('Hidden files included', async () => {
+  it('Includes .git directory when includeGitDirectory is true', async () => {
-    const searchPath = path.join(root, '**/*')
+    const searchResult = await findFilesToUpload(root, {
-    const searchResult = await findFilesToUpload(searchPath, true)
+      includeGitDirectory: true
-
+    })
-    expect(searchResult.filesToUpload).toContain(hiddenFile)
+    expect(searchResult.filesToUpload.length).toEqual(17)
-    expect(searchResult.filesToUpload).toContain(fileInHiddenFolderPath)
+    expect(searchResult.filesToUpload).toContain(gitConfigPath)
-    expect(searchResult.filesToUpload).toContain(fileInHiddenFolderInFolderA)
   })
 })

action.yml

@@ -40,10 +40,8 @@ inputs:
       If false, the action will fail if an artifact for the given name already exists.
       Does not fail if the artifact does not exist.
     default: 'false'
-  include-hidden-files:
+  include-git-directory:
-    description: >
+    description: 'Include files in the .git directory in the artifact.'
-      If true, hidden files will be included in the artifact.
-      If false, hidden files will be excluded from the artifact.
     default: 'false'
 
 outputs:

docs/MIGRATION.md

@@ -4,7 +4,6 @@
   - [Multiple uploads to the same named Artifact](#multiple-uploads-to-the-same-named-artifact)
   - [Overwriting an Artifact](#overwriting-an-artifact)
   - [Merging multiple artifacts](#merging-multiple-artifacts)
-  - [Hidden files](#hidden-files)
 
 Several behavioral differences exist between Artifact actions `v3` and below vs `v4`. This document outlines common scenarios in `v3`, and how they would be handled in `v4`.
 
@@ -209,26 +208,25 @@ jobs:
 
 Note that this will download all artifacts to a temporary directory and reupload them as a single artifact. For more information on inputs and other use cases for `actions/upload-artifact/merge@v4`, see [the action documentation](../merge/README.md).
 
-## Hidden Files
+## `.git` Directory
 
-By default, hidden files are ignored by this action to avoid unintentionally uploading sensitive
+By default, files in the `.git` directory are ignored to avoid unintentionally uploading
-information.
+credentials.
 
-In versions of this action before v4.4.0, these hidden files were included by default.
+In versions of this action before `v4.4.0`, files in the `.git` directory were included by default.
-
+If this directory is required, ensure credentials are not saved in `.git/config` and then
-If you need to upload hidden files, you can use the `include-hidden-files` input.
+enable the `include-git-directory` input.
 
 ```yaml
 jobs:
   upload:
     runs-on: ubuntu-latest
     steps:
-      - name: Create a Hidden File
+      - uses: actions/checkout@v4
-        run: echo "hello from a hidden file" > .hidden-file.txt
       - name: Upload Artifact
         uses: actions/upload-artifact@v3
         with:
-          path: .hidden-file.txt
+          path: .
 ```
 
 
@@ -237,12 +235,13 @@ jobs:
   upload:
     runs-on: ubuntu-latest
     steps:
-      - name: Create a Hidden File
+      - uses: actions/checkout@v4
-        run: echo "hello from a hidden file" > .hidden-file.txt
++       with:
++         persist-credentials: false
       - name: Upload Artifact
 -       uses: actions/upload-artifact@v3
 +       uses: actions/upload-artifact@v4
         with:
-          path: .hidden-file.txt
+          path: .
-+         include-hidden-files: true
++         include-git-directory: true
 ```

merge/README.md

@@ -5,6 +5,7 @@ Merge multiple [Actions Artifacts](https://docs.github.com/en/actions/using-work
 - [`@actions/upload-artifact/merge`](#actionsupload-artifactmerge)
   - [Usage](#usage)
     - [Inputs](#inputs)
+      - [Uploading the `.git` directory](#uploading-the-git-directory)
     - [Outputs](#outputs)
   - [Examples](#examples)
     - [Combining all artifacts in a workflow run](#combining-all-artifacts-in-a-workflow-run)
@@ -59,6 +60,44 @@ For most cases, this may not be the most efficient solution. See [the migration
     compression-level:
 ```
 
+#### Uploading the `.git` directory
+
+By default, files in a `.git` directory are ignored in the merged artifact.
+This is intended to prevent accidentally uploading Git credentials into an artifact that could then
+be extracted.
+If files in the `.git` directory are needed, ensure that `actions/checkout` is being used with
+`persist-credentials: false`.
+
+```yaml
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        foo: [a, b, c]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false # Ensure credentials are not saved in `.git/config`
+
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: my-artifact-${{ matrix.foo }}
+          path: .
+          include-git-directory: true
+
+  merge:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/upload-artifact/merge@v4
+        with:
+          include-git-directory: true
+```
+
 ### Outputs
 
 | Name | Description | Example |

merge/action.yml

@@ -36,10 +36,8 @@ inputs:
       If true, the artifacts that were merged will be deleted.
       If false, the artifacts will still exist.
     default: 'false'
-  include-hidden-files:
+  include-git-directory:
-    description: >
+    description: 'Include files in the .git directory in the merged artifact.'
-      If true, hidden files will be included in the merged artifact.
-      If false, hidden files will be excluded from the merged artifact.
     default: 'false'
 
 outputs:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "upload-artifact",
-  "version": "4.4.2",
+  "version": "4.4.0",
   "description": "Upload an Actions Artifact in a workflow run",
   "main": "dist/upload/index.js",
   "scripts": {
@@ -29,10 +29,10 @@
   },
   "homepage": "https://github.com/actions/upload-artifact#readme",
   "dependencies": {
-    "@actions/artifact": "^2.1.11",
+    "@actions/artifact": "2.1.8",
-    "@actions/core": "^1.11.1",
+    "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
-    "@actions/glob": "^0.5.0",
+    "@actions/glob": "^0.3.0",
     "@actions/io": "^1.1.2",
     "minimatch": "^9.0.3"
   },

src/merge/constants.ts

@@ -6,5 +6,5 @@ export enum Inputs {
   RetentionDays = 'retention-days',
   CompressionLevel = 'compression-level',
   DeleteMerged = 'delete-merged',
-  IncludeHiddenFiles = 'include-hidden-files'
+  IncludeGitDirectory = 'include-git-directory'
 }

src/merge/input-helper.ts

@@ -10,7 +10,7 @@ export function getInputs(): MergeInputs {
   const pattern = core.getInput(Inputs.Pattern, {required: true})
   const separateDirectories = core.getBooleanInput(Inputs.SeparateDirectories)
   const deleteMerged = core.getBooleanInput(Inputs.DeleteMerged)
-  const includeHiddenFiles = core.getBooleanInput(Inputs.IncludeHiddenFiles)
+  const includeGitDirectory = core.getBooleanInput(Inputs.IncludeGitDirectory)
 
   const inputs = {
     name,
@@ -19,7 +19,7 @@ export function getInputs(): MergeInputs {
     deleteMerged,
     retentionDays: 0,
     compressionLevel: 6,
-    includeHiddenFiles
+    includeGitDirectory
   } as MergeInputs
 
   const retentionDaysStr = core.getInput(Inputs.RetentionDays)

src/merge/merge-artifacts.ts

@@ -62,10 +62,9 @@ export async function run(): Promise<void> {
     options.compressionLevel = inputs.compressionLevel
   }
 
-  const searchResult = await findFilesToUpload(
+  const searchResult = await findFilesToUpload(tmpDir, {
-    tmpDir,
+    includeGitDirectory: inputs.includeGitDirectory
-    inputs.includeHiddenFiles
+  })
-  )
 
   await uploadArtifact(
     inputs.name,

src/merge/merge-inputs.ts

@@ -32,7 +32,7 @@ export interface MergeInputs {
   separateDirectories: boolean
 
   /**
-   * Whether or not to include hidden files in the artifact
+   * Include files in the `.git` directory in the artifact
    */
-  includeHiddenFiles: boolean
+  includeGitDirectory: boolean
 }

src/shared/search.ts

@@ -11,12 +11,11 @@ export interface SearchResult {
   rootDirectory: string
 }
 
-function getDefaultGlobOptions(includeHiddenFiles: boolean): glob.GlobOptions {
+function getDefaultGlobOptions(): glob.GlobOptions {
   return {
     followSymbolicLinks: true,
     implicitDescendants: true,
-    omitBrokenSymbolicLinks: true,
+    omitBrokenSymbolicLinks: true
-    excludeHiddenFiles: !includeHiddenFiles
   }
 }
 
@@ -79,15 +78,21 @@ function getMultiPathLCA(searchPaths: string[]): string {
   return path.join(...commonPaths)
 }
 
+export interface SearchOptions {
+  /**
+   * Indicates whether files in the .git directory should be included in the artifact
+   *
+   * @default false
+   */
+  includeGitDirectory: boolean
+}
+
 export async function findFilesToUpload(
   searchPath: string,
-  includeHiddenFiles?: boolean
+  searchOptions?: SearchOptions
 ): Promise<SearchResult> {
   const searchResults: string[] = []
-  const globber = await glob.create(
+  const globber = await glob.create(searchPath, getDefaultGlobOptions())
-    searchPath,
-    getDefaultGlobOptions(includeHiddenFiles || false)
-  )
   const rawSearchResults: string[] = await globber.glob()
 
   /*
@@ -105,6 +110,12 @@ export async function findFilesToUpload(
     // isDirectory() returns false for symlinks if using fs.lstat(), make sure to use fs.stat() instead
     if (!fileStats.isDirectory()) {
       debug(`File:${searchResult} was found using the provided searchPath`)
+
+      if (!searchOptions?.includeGitDirectory && inGitDirectory(searchResult)) {
+        debug(`Ignoring ${searchResult} because it is in the .git directory`)
+        continue
+      }
+
       searchResults.push(searchResult)
 
       // detect any files that would be overwritten because of case insensitivity
@@ -156,3 +167,15 @@ export async function findFilesToUpload(
     rootDirectory: searchPaths[0]
   }
 }
+
+function inGitDirectory(filePath: string): boolean {
+  // The .git directory is a directory, so we need to check if the file path is a directory
+  // and if it is a .git directory
+  for (const part of filePath.split(path.sep)) {
+    if (part === '.git') {
+      return true
+    }
+  }
+
+  return false
+}

src/upload/constants.ts

@@ -6,7 +6,7 @@ export enum Inputs {
   RetentionDays = 'retention-days',
   CompressionLevel = 'compression-level',
   Overwrite = 'overwrite',
-  IncludeHiddenFiles = 'include-hidden-files'
+  IncludeGitDirectory = 'include-git-directory'
 }
 
 export enum NoFileOptions {

src/upload/input-helper.ts

@@ -9,7 +9,7 @@ export function getInputs(): UploadInputs {
   const name = core.getInput(Inputs.Name)
   const path = core.getInput(Inputs.Path, {required: true})
   const overwrite = core.getBooleanInput(Inputs.Overwrite)
-  const includeHiddenFiles = core.getBooleanInput(Inputs.IncludeHiddenFiles)
+  const includeGitDirectory = core.getBooleanInput(Inputs.IncludeGitDirectory)
 
   const ifNoFilesFound = core.getInput(Inputs.IfNoFilesFound)
   const noFileBehavior: NoFileOptions = NoFileOptions[ifNoFilesFound]
@@ -29,7 +29,7 @@ export function getInputs(): UploadInputs {
     searchPath: path,
     ifNoFilesFound: noFileBehavior,
     overwrite: overwrite,
-    includeHiddenFiles: includeHiddenFiles
+    includeGitDirectory: includeGitDirectory
   } as UploadInputs
 
   const retentionDaysStr = core.getInput(Inputs.RetentionDays)

src/upload/upload-artifact.ts

@@ -24,10 +24,9 @@ async function deleteArtifactIfExists(artifactName: string): Promise<void> {
 
 export async function run(): Promise<void> {
   const inputs = getInputs()
-  const searchResult = await findFilesToUpload(
+  const searchResult = await findFilesToUpload(inputs.searchPath, {
-    inputs.searchPath,
+    includeGitDirectory: inputs.includeGitDirectory
-    inputs.includeHiddenFiles
+  })
-  )
   if (searchResult.filesToUpload.length === 0) {
     // No files were found, different use cases warrant different types of behavior if nothing is found
     switch (inputs.ifNoFilesFound) {

src/upload/upload-inputs.ts

@@ -32,7 +32,7 @@ export interface UploadInputs {
   overwrite: boolean
 
   /**
-   * Whether or not to include hidden files in the artifact
+   * Include files in the `.git` directory in the artifact
    */
-  includeHiddenFiles: boolean
+  includeGitDirectory: boolean
 }