Extra Documentation

* V2 Upload Artifact

* Improve logs

* Update release

* Update test.yml

* Update test.yml

* Update test.yml

* @actions/artifact v0.2.0 package

* Add extra YAML test

.gitattributes

@@ -1 +0,0 @@
-* text=auto eol=lf

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,33 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**Version**
-- [ ] V1
-- [ ] V2
-
-**Environment**
-- [ ] self-hosted
-- [ ] Linux
-- [ ] Windows
-- [ ] Mac
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Run/Repo Url**
-If applicable, and if your repo/run is public, please include a URL so it is easier for us to investigate.
-
-**How to reproduce**
-If applicable, add information on how to reproduce the problem.
-
-**Additional context**
-Add any other context about the problem here.

.github/workflows/codeql-analysis.yml

@@ -1,44 +0,0 @@
-name: "Code scanning - action"
-
-on:
-  push:
-    paths-ignore:
-      - '**.md'
-  schedule:
-    - cron: '0 6 * * 3'
-
-jobs:
-  CodeQL-Build:
-
-    # CodeQL runs on ubuntu-latest and windows-latest
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      # Override language selection by uncommenting this and choosing your languages
-      # with:
-      #   languages: go, javascript, csharp, python, cpp, java
-
-    # 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@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

.github/workflows/test.yml

@@ -1,11 +1,13 @@
 name: Test
 on:
   push:
-    branches:
-      - master
+    branches:	
+      - v2-preview
     paths-ignore:
       - '**.md'
   pull_request:
+    branches:	
+      - v2-preview
     paths-ignore:
       - '**.md'
 
@@ -16,7 +18,7 @@ jobs:
 
     strategy:
       matrix:
-        runs-on: [ubuntu-latest, macos-latest, windows-latest]
+        runs-on: [ubuntu-latest, macOS-latest, windows-latest]
       fail-fast: false
 
     runs-on: ${{ matrix.runs-on }}
@@ -75,16 +77,6 @@ jobs:
         name: 'GZip-Artifact'
         path: path/to/dir-3/
 
-    # Upload a directory that contains a file that will be uploaded with GZip
-    - name: 'Upload artifact #4'
-      uses: ./
-      with:
-        name: 'Multi-Path-Artifact'
-        path: |
-          path/to/dir-1/*
-          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
@@ -148,23 +140,3 @@ jobs:
             Write-Error "File contents of downloaded artifact is incorrect"
         }
       shell: pwsh
-
-    - name: 'Download artifact #4'
-      uses: actions/download-artifact@v1
-      with:
-        name: 'Multi-Path-Artifact'
-        path: multi/artifact
-
-    - name: 'Verify Artifact #4'
-      run: |
-        $file1 = "multi/artifact/dir-1/file1.txt"
-        $file2 = "multi/artifact/dir-2/file2.txt"
-        if(!(Test-Path -path $file1) -or !(Test-Path -path $file2))
-        {
-            Write-Error "Expected files do not exist"
-        }
-        if(!((Get-Content $file1) -ceq "Lorem ipsum dolor sit amet") -or !((Get-Content $file2) -ceq "Hello world from file #2"))
-        {
-            Write-Error "File contents of downloaded artifacts are incorrect"
-        }
-      shell: pwsh

README.md

@@ -1,25 +1,9 @@
-# Upload-Artifact v2
+# Upload-Artifact v2 Preview
 
 This uploads artifacts from your workflow allowing you to share data between jobs and store data once a workflow is complete.
 
 See also [download-artifact](https://github.com/actions/download-artifact).
 
-# What's new
-
-- Easier upload 
-  - Specify a wildcard pattern
-  - Specify an individual file
-  - Specify a directory (previously you were limited to only this option)
-  - Multi path upload
-    - Use a combination of individual files, wildcards or directories
-    - Support for excluding certain files
-- Upload an artifact without providing a name
-- Fix for artifact uploads sometimes not working with containers
-- Proxy support out of the box
-- Port entire action to typescript from a runner plugin so it is easier to collaborate and accept contributions
-
-Refer [here](https://github.com/actions/upload-artifact/tree/releases/v1) for the previous version
-
 # Usage
 
 See [action.yml](action.yml)
@@ -33,7 +17,7 @@ steps:
 
 - run: echo hello > path/to/artifact/world.txt
 
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   with:
     name: my-artifact
     path: path/to/artifact/world.txt
@@ -42,58 +26,32 @@ steps:
 ### Upload an Entire Directory
 
 ```yaml
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   with:
     name: my-artifact
     path: path/to/artifact/ # or path/to/artifact
 ```
 
-### Upload using a Wildcard Pattern
+### Upload using a Wildcard Pattern:
 ```yaml
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   with:
     name: my-artifact
     path: path/**/[abc]rtifac?/*
 ```
 
-### Upload using Multiple Paths and Exclusions
-```yaml
-- uses: actions/upload-artifact@v2
-  with:
-    name: my-artifact
-    path: |
-      path/output/bin/
-      path/output/test-results
-      !path/**/*.tmp
-```
-
 For supported wildcards along with behavior and documentation, see [@actions/glob](https://github.com/actions/toolkit/tree/master/packages/glob) which is used internally to search for files.
 
-If a wildcard pattern is used, the path hierarchy will be preserved after the first wildcard pattern. 
+Relative and absolute file paths are both allowed. Relative paths are rooted against the current working directory.
 
-```
-    path/to/*/directory/foo?.txt =>
-        ∟ path/to/some/directory/foo1.txt
-        ∟ path/to/some/directory/foo2.txt
-        ∟ path/to/other/directory/foo1.txt
-
-    would be flattened and uploaded as =>
-        ∟ some/directory/foo1.txt
-        ∟ some/directory/foo2.txt
-        ∟ other/directory/foo1.txt
-```
-If multiple paths are provided as input, the least common ancestor of all the search paths will be used as the root directory of the artifact. Exclude paths do not effect the directory structure.
-
-Relative and absolute file paths are both allowed. Relative paths are rooted against the current working directory. Paths that begin with a wildcard character should be quoted to avoid being interpreted as YAML aliases.
-
-The [@actions/artifact](https://github.com/actions/toolkit/tree/master/packages/artifact) package is used internally to handle most of the logic around uploading an artifact. There is extra documentation around upload limitations and behavior in the toolkit repo that is worth checking out.
+The [@actions/artifact](https://github.com/actions/toolkit/tree/master/packages/artifact) package is also used internally to handle most of the logic around uploading an artifact. There is extra documentation around upload limitations and behavior in the toolkit repo that is worth checking out.
 
 ### Conditional Artifact Upload
 
 To upload artifacts only when the previous step of a job failed, use [`if: failure()`](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions#job-status-check-functions):
 
 ```yaml
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   if: failure()
   with:
     name: my-artifact
@@ -104,7 +62,7 @@ To upload artifacts only when the previous step of a job failed, use [`if: failu
 
 You can upload an artifact without specifying a name
 ```yaml
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   with:
     path: path/to/artifact/world.txt
 ```
@@ -117,47 +75,22 @@ Each artifact behaves as a file share. Uploading to the same artifact multiple t
 
 ```yaml
 - run: echo hi > world.txt
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   with:
     path: world.txt
 
 - run: echo howdy > extra-file.txt
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   with:
     path: extra-file.txt
 
 - run: echo hello > world.txt
-- uses: actions/upload-artifact@v2
+- uses: actions/upload-artifact@v2-preview
   with:
     path: world.txt
 ```
 With the following example, the available artifact (named `artifact` which is the default if no name is provided) would contain both `world.txt` (`hello`) and `extra-file.txt` (`howdy`).
 
-> **_Warning:_**  Be careful when uploading to the same artifact via multiple jobs as artifacts may become corrupted 
-
-```yaml
-    strategy:
-      matrix:
-          node-version: [8.x, 10.x, 12.x, 13.x]
-    steps:
-        - name: 'Create a file'
-          run: echo ${{ matrix.node-version }} > my_file.txt
-        - name: 'Accidently upload to the same artifact via multiple jobs'
-          uses: 'actions/upload-artifact@v2'
-          with:
-              name: my-artifact
-              path: ${{ github.workspace }}
-```
-
-In the above example, four jobs will upload four different files to the same artifact but there will only be one file available when `my-artifact` is downloaded. Each job overwrites what was previously uploaded. To ensure that jobs don't overwrite existing artifacts, use a different name per job.
-
-```yaml
-          uses: 'actions/upload-artifact@v2'
-          with:
-              name: my-artifact ${{ matrix.node-version }}
-              path: ${{ github.workspace }}
-```
-
 ### Environment Variables and Tilde Expansion
 
 You can use `~` in the path input as a substitute for `$HOME`. Basic tilde expansion is supported.
@@ -166,7 +99,7 @@ You can use `~` in the path input as a substitute for `$HOME`. Basic tilde expan
   - run: |	
       mkdir -p ~/new/artifact
       echo hello > ~/new/artifact/world.txt
-  - uses: actions/upload-artifact@v2
+  - uses: actions/upload-artifact@v2-preview
     with:	
       name: 'Artifacts-V2'	
       path: '~/new/**/*'
@@ -181,7 +114,7 @@ Environment variables along with context expressions can also be used for input.
     - run: |	
         mkdir -p ${{ github.workspace }}/artifact
         echo hello > ${{ github.workspace }}/artifact/world.txt
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v2-preview
       with:	
         name: ${{ env.name }}-name	
         path: ${{ github.workspace }}/artifact/**/*
@@ -191,7 +124,7 @@ Environment variables along with context expressions can also be used for input.
 In the top right corner of a workflow run, once the run is over, if you used this action, there will be a `Artifacts` dropdown which you can download items from. Here's a screenshot of what it looks like<br/>
 <img src="https://user-images.githubusercontent.com/16109154/72556687-20235a80-386d-11ea-9e2a-b534faa77083.png" width="375" height="140">
 
-There is a trashcan icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository. 
+There is a trash can icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository.
 
 ## Additional Documentation
 

__tests__/search.test.ts

@@ -231,7 +231,7 @@ describe('Search', () => {
 
     expect(searchResult.filesToUpload.includes(searchItem1Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(searchItem2Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem3Path)).toEqual(true)
+    expect(searchResult.filesToUpload.includes(searchItem2Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(searchItem4Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(searchItem5Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(extraSearchItem1Path)).toEqual(
@@ -265,7 +265,7 @@ describe('Search', () => {
 
     expect(searchResult.filesToUpload.includes(searchItem1Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(searchItem2Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem3Path)).toEqual(true)
+    expect(searchResult.filesToUpload.includes(searchItem2Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(searchItem4Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(searchItem5Path)).toEqual(true)
     expect(searchResult.filesToUpload.includes(extraSearchItem1Path)).toEqual(
@@ -286,70 +286,4 @@ describe('Search', () => {
 
     expect(searchResult.rootDirectory).toEqual(root)
   })
-
-  it('Multi path search - root directory', async () => {
-    const searchPath1 = path.join(root, 'folder-a')
-    const searchPath2 = path.join(root, 'folder-d')
-
-    const searchPaths = searchPath1 + '\n' + searchPath2
-    const searchResult = await findFilesToUpload(searchPaths)
-
-    expect(searchResult.rootDirectory).toEqual(root)
-    expect(searchResult.filesToUpload.length).toEqual(7)
-    expect(searchResult.filesToUpload.includes(searchItem1Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem2Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem3Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem4Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(extraSearchItem1Path)).toEqual(
-      true
-    )
-    expect(searchResult.filesToUpload.includes(extraSearchItem2Path)).toEqual(
-      true
-    )
-    expect(searchResult.filesToUpload.includes(extraFileInFolderCPath)).toEqual(
-      true
-    )
-  })
-
-  it('Multi path search - with exclude character', async () => {
-    const searchPath1 = path.join(root, 'folder-a')
-    const searchPath2 = path.join(root, 'folder-d')
-    const searchPath3 = path.join(root, 'folder-a', 'folder-b', '**/extra*.txt')
-
-    // negating the third search path
-    const searchPaths = searchPath1 + '\n' + searchPath2 + '\n!' + searchPath3
-    const searchResult = await findFilesToUpload(searchPaths)
-
-    expect(searchResult.rootDirectory).toEqual(root)
-    expect(searchResult.filesToUpload.length).toEqual(5)
-    expect(searchResult.filesToUpload.includes(searchItem1Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem2Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem3Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(searchItem4Path)).toEqual(true)
-    expect(searchResult.filesToUpload.includes(extraSearchItem2Path)).toEqual(
-      true
-    )
-  })
-
-  it('Multi path search - non root directory', async () => {
-    const searchPath1 = path.join(root, 'folder-h', 'folder-i')
-    const searchPath2 = path.join(root, 'folder-h', 'folder-j', 'folder-k')
-    const searchPath3 = amazingFileInFolderHPath
-
-    const searchPaths = [searchPath1, searchPath2, searchPath3].join('\n')
-    const searchResult = await findFilesToUpload(searchPaths)
-
-    expect(searchResult.rootDirectory).toEqual(path.join(root, 'folder-h'))
-    expect(searchResult.filesToUpload.length).toEqual(4)
-    expect(
-      searchResult.filesToUpload.includes(amazingFileInFolderHPath)
-    ).toEqual(true)
-    expect(searchResult.filesToUpload.includes(extraSearchItem4Path)).toEqual(
-      true
-    )
-    expect(searchResult.filesToUpload.includes(extraSearchItem5Path)).toEqual(
-      true
-    )
-    expect(searchResult.filesToUpload.includes(lonelyFilePath)).toEqual(true)
-  })
 })

package.json

@@ -1,6 +1,6 @@
 {
   "name": "upload-artifact",
-  "version": "2.0.1",
+  "version": "2.0.0",
   "description": "Upload a build artifact that can be used by subsequent workflow steps",
   "main": "dist/index.js",
   "scripts": {
@@ -29,23 +29,23 @@
   },
   "homepage": "https://github.com/actions/upload-artifact#readme",
   "devDependencies": {
-    "@actions/artifact": "^0.3.2",
+    "@actions/artifact": "^0.2.0",
     "@actions/core": "^1.2.3",
     "@actions/glob": "^0.1.0",
     "@actions/io": "^1.0.2",
-    "@types/jest": "^25.2.1",
-    "@types/node": "^13.11.1",
-    "@typescript-eslint/parser": "^2.27.0",
-    "@zeit/ncc": "^0.22.1",
+    "@types/jest": "^25.1.4",
+    "@types/node": "^12.12.30",
+    "@typescript-eslint/parser": "^2.23.0",
+    "@zeit/ncc": "^0.20.5",
     "concurrently": "^5.1.0",
-    "eslint": "^7.4.0",
+    "eslint": "^6.8.0",
     "eslint-plugin-github": "^3.4.1",
     "eslint-plugin-jest": "^23.8.2",
     "glob": "^7.1.6",
-    "jest": "^26.1.0",
-    "jest-circus": "^26.1.0",
-    "prettier": "^2.0.4",
-    "ts-jest": "^25.3.1",
+    "jest": "^25.1.0",
+    "jest-circus": "^25.1.0",
+    "prettier": "^1.19.1",
+    "ts-jest": "^25.2.1",
     "typescript": "^3.8.3"
   }
 }

src/search.ts

@@ -1,6 +1,5 @@
 import * as glob from '@actions/glob'
-import * as path from 'path'
-import {debug, info} from '@actions/core'
+import {debug} from '@actions/core'
 import {lstatSync} from 'fs'
 import {dirname} from 'path'
 
@@ -17,65 +16,6 @@ function getDefaultGlobOptions(): glob.GlobOptions {
   }
 }
 
-/**
- * If multiple paths are specific, the least common ancestor (LCA) of the search paths is used as
- * the delimiter to control the directory structure for the artifact. This function returns the LCA
- * when given an array of search paths
- *
- * Example 1: The patterns `/foo/` and `/bar/` returns `/`
- *
- * Example 2: The patterns `~/foo/bar/*` and `~/foo/voo/two/*` and `~/foo/mo/` returns `~/foo`
- */
-function getMultiPathLCA(searchPaths: string[]): string {
-  if (searchPaths.length < 2) {
-    throw new Error('At least two search paths must be provided')
-  }
-
-  const commonPaths = new Array<string>()
-  const splitPaths = new Array<string[]>()
-  let smallestPathLength = Number.MAX_SAFE_INTEGER
-
-  // split each of the search paths using the platform specific separator
-  for (const searchPath of searchPaths) {
-    debug(`Using search path ${searchPath}`)
-
-    const splitSearchPath = path.normalize(searchPath).split(path.sep)
-
-    // keep track of the smallest path length so that we don't accidentally later go out of bounds
-    smallestPathLength = Math.min(smallestPathLength, splitSearchPath.length)
-    splitPaths.push(splitSearchPath)
-  }
-
-  // on Unix-like file systems, the file separator exists at the beginning of the file path, make sure to preserve it
-  if (searchPaths[0].startsWith(path.sep)) {
-    commonPaths.push(path.sep)
-  }
-
-  let splitIndex = 0
-  // function to check if the paths are the same at a specific index
-  function isPathTheSame(): boolean {
-    const compare = splitPaths[0][splitIndex]
-    for (let i = 1; i < splitPaths.length; i++) {
-      if (compare !== splitPaths[i][splitIndex]) {
-        // a non-common index has been reached
-        return false
-      }
-    }
-    return true
-  }
-
-  // Loop over all the search paths until there is a non-common ancestor or we go out of bounds
-  while (splitIndex < smallestPathLength) {
-    if (!isPathTheSame()) {
-      break
-    }
-    // if all are the same, add to the end result & increment the index
-    commonPaths.push(splitPaths[0][splitIndex])
-    splitIndex++
-  }
-  return path.join(...commonPaths)
-}
-
 export async function findFilesToUpload(
   searchPath: string,
   globOptions?: glob.GlobOptions
@@ -102,22 +42,13 @@ export async function findFilesToUpload(
     }
   }
 
-  // Calculate the root directory for the artifact using the search paths that were utilized
+  /*
+    Only a single search pattern is being included so only 1 searchResult is expected. In the future if multiple search patterns are
+    simultaneously supported this will change
+  */
   const searchPaths: string[] = globber.getSearchPaths()
-
   if (searchPaths.length > 1) {
-    info(
-      `Multiple search paths detected. Calculating the least common ancestor of all paths`
-    )
-    const lcaSearchPath = getMultiPathLCA(searchPaths)
-    info(
-      `The least common ancestor is ${lcaSearchPath}. This will be the root directory of the artifact`
-    )
-
-    return {
-      filesToUpload: searchResults,
-      rootDirectory: lcaSearchPath
-    }
+    throw new Error('Only 1 search path should be returned')
   }
 
   /*

src/upload-artifact.ts

@@ -21,24 +21,16 @@ async function run(): Promise<void> {
 
       const artifactClient = create()
       const options: UploadOptions = {
-        continueOnError: false
+        continueOnError: true
       }
-      const uploadResponse = await artifactClient.uploadArtifact(
+      await artifactClient.uploadArtifact(
         name || getDefaultArtifactName(),
         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.`
-        )
-      } else {
-        core.info(
-          `Artifact ${uploadResponse.artifactName} has been successfully uploaded!`
-        )
-      }
+      core.info('Artifact upload has finished successfully!')
     }
   } catch (err) {
     core.setFailed(err.message)