Merge branch 'main' into konradpabjan/bump-actions-artifact

.devcontainer/devcontainer.json

@@ -1,6 +0,0 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
-{
-	"name": "@actions/upload-artifact",
-	"image": "mcr.microsoft.com/devcontainers/typescript-node:0-16"
-}

.eslintrc.json

@@ -4,10 +4,13 @@
     "parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
     "extends": [
       "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
       "plugin:import/errors",
       "plugin:import/warnings",
       "plugin:import/typescript",
-      "plugin:prettier/recommended"
+      "plugin:prettier/recommended",
+      "prettier/@typescript-eslint"
     ],
     "rules": {
        "@typescript-eslint/no-empty-function": "off"

.github/workflows/check-dist.yml

@@ -20,23 +20,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v2
 
-      - name: Setup Node 20
+      - name: Set Node.js 12.x
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@v1
         with:
-          node-version: 20.x
+          node-version: 12.x
-          cache: 'npm'
+
-  
       - name: Install dependencies
         run: npm ci
 
       - name: Move the committed index.js file
         run: mv dist/index.js /tmp
 
-      - name: Rebuild with tsc
-        run: npm run build
-
       - name: Rebuild the index.js file
         run: npm run release
 
@@ -45,7 +41,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v7
+      - uses: actions/upload-artifact@v2
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: index.js

.github/workflows/codeql-analysis.yml

@@ -17,11 +17,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v6
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
+      uses: github/codeql-action/init@v1
       # Override language selection by uncommenting this and choosing your languages
       # with:
       #   languages: go, javascript, csharp, python, cpp, java
@@ -29,7 +29,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+      uses: github/codeql-action/autobuild@v1
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -43,4 +43,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      uses: github/codeql-action/analyze@v1

.github/workflows/licensed.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Check licenses
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v2
       - run: npm ci
       - name: Install licensed
         run: |

.github/workflows/test.yml

@@ -25,11 +25,10 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v3
 
-    - name: Setup Node 16
+    - name: Set Node.js 12.x
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v1
       with:
-        node-version: 16.x
+        node-version: 12.x
-        cache: 'npm'
 
     - name: Install dependencies
       run: npm ci
@@ -37,21 +36,21 @@ jobs:
     - name: Compile
       run: npm run build
 
+    - name: npm test
+      run: npm test
+
     - name: Lint
       run: npm run lint
 
     - name: Format
       run: npm run format-check
 
-    - name: Test
-      run: npm run test
-
     # 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 path/to/dir-3    
         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 "This is a going to be a test for a large enough file that should get compressed with GZip. The @actions/artifact package uses GZip to upload files. This text should have a compression ratio greater than 100% so it should get uploaded using GZip" > path/to/dir-3/gzip.txt
@@ -86,9 +85,11 @@ jobs:
           path/to/dir-[23]/*
           !path/to/dir-3/*.txt
 
+    # Verify artifacts. Switch to download-artifact@v2 once it's out of preview
+
     # Download Artifact #1 and verify the correctness of the content
     - name: 'Download artifact #1'
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v1
       with:
         name: 'Artifact-A'
         path: some/new/path
@@ -108,7 +109,7 @@ jobs:
 
     # Download Artifact #2 and verify the correctness of the content
     - name: 'Download artifact #2'
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v1
       with:
         name: 'artifact'
         path: some/other/path
@@ -126,10 +127,10 @@ jobs:
             Write-Error "File contents of downloaded artifacts are incorrect"
         }
       shell: pwsh
-
+    
     # Download Artifact #3 and verify the correctness of the content
     - name: 'Download artifact #3'
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v1
       with:
         name: 'GZip-Artifact'
         path: gzip/artifact/path
@@ -149,7 +150,7 @@ jobs:
       shell: pwsh
 
     - name: 'Download artifact #4'
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v1
       with:
         name: 'Multi-Path-Artifact'
         path: multi/artifact

README.md

@@ -237,29 +237,6 @@ Artifacts are retained for 90 days by default. You can specify a shorter retenti
 
 The retention period must be between 1 and 90 inclusive. For more information see [artifact and log retention policies](https://docs.github.com/en/free-pro-team@latest/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy).
 
-
-### Hidden Files 
-
-By default, hidden files are ignored by this action to avoid unintentionally uploading sensitive information.
-
-In versions of this action before v3.2.0, these hidden files were included by default.
-
-If you need to upload hidden files, you can use the `include-hidden-files` input.
-
-```yaml
-jobs:
-  upload:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Create a Hidden File
-        run: echo "hello from a hidden file" > .hidden-file.txt
-      - name: Upload Artifact
-        uses: actions/upload-artifact@v3
-        with:
-          path: .hidden-file.txt
-          include-hidden-files: true
-```
-
 ## Where does the upload go?
 
 At the bottom of the workflow summary page, there is a dedicated section for artifacts. Here's a screenshot of something you might see:

__tests__/search.test.ts

@@ -61,20 +61,6 @@ const lonelyFilePath = path.join(
   'lonely-file.txt'
 )
 
-const hiddenFile = path.join(root, '.hidden-file.txt')
-const fileInHiddenFolderPath = path.join(
-  root,
-  '.hidden-folder',
-  'folder-in-hidden-folder',
-  'file.txt'
-)
-const fileInHiddenFolderInFolderA = path.join(
-  root,
-  'folder-a',
-  '.hidden-folder-in-folder-a',
-  'file.txt'
-)
-
 describe('Search', () => {
   beforeAll(async () => {
     // mock all output so that there is less noise when running tests
@@ -106,13 +92,6 @@ describe('Search', () => {
     await fs.mkdir(path.join(root, 'folder-h', 'folder-j', 'folder-k'), {
       recursive: true
     })
-    await fs.mkdir(
-      path.join(root, '.hidden-folder', 'folder-in-hidden-folder'),
-      {recursive: true}
-    )
-    await fs.mkdir(path.join(root, 'folder-a', '.hidden-folder-in-folder-a'), {
-      recursive: true
-    })
 
     await fs.writeFile(searchItem1Path, 'search item1 file')
     await fs.writeFile(searchItem2Path, 'search item2 file')
@@ -131,19 +110,10 @@ describe('Search', () => {
     await fs.writeFile(amazingFileInFolderHPath, 'amazing file')
 
     await fs.writeFile(lonelyFilePath, 'all by itself')
-
-    await fs.writeFile(hiddenFile, 'hidden file')
-    await fs.writeFile(fileInHiddenFolderPath, 'file in hidden directory')
-    await fs.writeFile(fileInHiddenFolderInFolderA, 'file in hidden directory')
     /*
       Directory structure of files that get created:
       root/
-          .hidden-folder/
-            folder-in-hidden-folder/
-              file.txt
           folder-a/
-              .hidden-folder-in-folder-a/
-                file.txt
               folder-b/
                   folder-c/
                       search-item1.txt
@@ -166,7 +136,6 @@ describe('Search', () => {
               folder-j/
                   folder-k/
                       lonely-file.txt
-          .hidden-file.txt
           search-item5.txt
     */
   })
@@ -383,24 +352,4 @@ describe('Search', () => {
     )
     expect(searchResult.filesToUpload.includes(lonelyFilePath)).toEqual(true)
   })
-
-  it('Hidden files ignored by default', async () => {
-    const searchPath = path.join(root, '**/*')
-    const searchResult = await findFilesToUpload(searchPath)
-
-    expect(searchResult.filesToUpload).not.toContain(hiddenFile)
-    expect(searchResult.filesToUpload).not.toContain(fileInHiddenFolderPath)
-    expect(searchResult.filesToUpload).not.toContain(
-      fileInHiddenFolderInFolderA
-    )
-  })
-
-  it('Hidden files included', async () => {
-    const searchPath = path.join(root, '**/*')
-    const searchResult = await findFilesToUpload(searchPath, true)
-
-    expect(searchResult.filesToUpload).toContain(hiddenFile)
-    expect(searchResult.filesToUpload).toContain(fileInHiddenFolderPath)
-    expect(searchResult.filesToUpload).toContain(fileInHiddenFolderInFolderA)
-  })
 })

action.yml

@@ -23,11 +23,6 @@ inputs:
 
       Minimum 1 day.
       Maximum 90 days unless changed from the repository settings page.
-  include-hidden-files:
-    description: >
-      If true, hidden files will be included in the uploaded artifact.
-      If false, hidden files will be excluded from the uploaded artifact.
-    default: 'false'
 runs:
-  using: 'node20'
+  using: 'node16'
   main: 'dist/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "upload-artifact",
-  "version": "3.2.2",
+  "version": "3.0.0",
   "description": "Upload a build artifact that can be used by subsequent workflow steps",
   "main": "dist/index.js",
   "scripts": {
@@ -29,25 +29,25 @@
   },
   "homepage": "https://github.com/actions/upload-artifact#readme",
   "dependencies": {
-    "@actions/artifact": "^1.1.3",
+    "@actions/artifact": "^1.1.1",
     "@actions/core": "^1.10.0",
-    "@actions/glob": "^0.5.0",
+    "@actions/glob": "^0.3.0",
     "@actions/io": "^1.1.2"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.5",
+    "@types/jest": "^25.2.1",
-    "@types/node": "^18.11.18",
+    "@types/node": "^13.11.1",
-    "@typescript-eslint/parser": "^5.48.0",
+    "@typescript-eslint/parser": "^2.27.0",
-    "@vercel/ncc": "^0.36.0",
+    "@zeit/ncc": "^0.22.1",
-    "concurrently": "^7.6.0",
+    "concurrently": "^5.1.0",
-    "eslint": "^8.31.0",
+    "eslint": "^7.4.0",
-    "eslint-plugin-github": "^4.6.0",
+    "eslint-plugin-github": "^4.1.1",
-    "eslint-plugin-jest": "^27.2.0",
+    "eslint-plugin-jest": "^23.8.2",
-    "glob": "^8.0.3",
+    "glob": "^7.1.6",
-    "jest": "^29.3.1",
+    "jest": "^27.2.5",
-    "jest-circus": "^29.3.1",
+    "jest-circus": "^27.2.5",
-    "prettier": "^2.8.1",
+    "prettier": "^2.0.4",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^27.0.6",
-    "typescript": "^4.9.4"
+    "typescript": "^3.8.3"
   }
-}
+}

src/constants.ts

@@ -1,10 +1,8 @@
-/* eslint-disable no-unused-vars */
 export enum Inputs {
   Name = 'name',
   Path = 'path',
   IfNoFilesFound = 'if-no-files-found',
-  RetentionDays = 'retention-days',
+  RetentionDays = 'retention-days'
-  IncludeHiddenFiles = 'include-hidden-files'
 }
 
 export enum NoFileOptions {

src/input-helper.ts

@@ -11,7 +11,6 @@ export function getInputs(): UploadInputs {
 
   const ifNoFilesFound = core.getInput(Inputs.IfNoFilesFound)
   const noFileBehavior: NoFileOptions = NoFileOptions[ifNoFilesFound]
-  const includeHiddenFiles = core.getBooleanInput(Inputs.IncludeHiddenFiles)
 
   if (!noFileBehavior) {
     core.setFailed(
@@ -26,8 +25,7 @@ export function getInputs(): UploadInputs {
   const inputs = {
     artifactName: name,
     searchPath: path,
-    ifNoFilesFound: noFileBehavior,
+    ifNoFilesFound: noFileBehavior
-    includeHiddenFiles
   } as UploadInputs
 
   const retentionDaysStr = core.getInput(Inputs.RetentionDays)

src/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
   }
 }
 
@@ -81,12 +80,12 @@ function getMultiPathLCA(searchPaths: string[]): string {
 
 export async function findFilesToUpload(
   searchPath: string,
-  includeHiddenFiles?: boolean
+  globOptions?: glob.GlobOptions
 ): Promise<SearchResult> {
   const searchResults: string[] = []
   const globber = await glob.create(
     searchPath,
-    getDefaultGlobOptions(includeHiddenFiles || false)
+    globOptions || getDefaultGlobOptions()
   )
   const rawSearchResults: string[] = await globber.glob()
 

src/upload-artifact.ts

@@ -7,10 +7,7 @@ import {NoFileOptions} from './constants'
 async function run(): Promise<void> {
   try {
     const inputs = getInputs()
-    const searchResult = await findFilesToUpload(
+    const searchResult = await findFilesToUpload(inputs.searchPath)
-      inputs.searchPath,
-      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) {
@@ -71,8 +68,8 @@ async function run(): Promise<void> {
         )
       }
     }
-  } catch (error) {
+  } catch (err) {
-    core.setFailed((error as Error).message)
+    core.setFailed(err.message)
   }
 }
 

src/upload-inputs.ts

@@ -20,9 +20,4 @@ export interface UploadInputs {
    * Duration after which artifact will expire in days
    */
   retentionDays: number
-
-  /**
-   * Whether or not to include hidden files in the artifact
-   */
-  includeHiddenFiles: boolean
 }