V2 Upload Artifact (#70)

* V2 Preview (#54) * 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 * Extra Documentation * Update README.md * Update README.md * Update NPM packages * Update to @actions/artifact 0.3.1 * Update readme from v2 preview to v2 * Add .gitattributes * Misc Updates * macOS to macos * Update YAML so only push events trigger on the master branch
actions · Apr 28, 2020 · e7eefc4 · e7eefc4
1 parent 1283ca1
commit e7eefc4
Show file tree

Hide file tree

Showing 18 changed files with 16,404 additions and 12 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,3 @@
+node_modules/
+lib/
+dist/
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,19 @@
+{
+    "env": { "node": true, "jest": true },
+    "parser": "@typescript-eslint/parser",
+    "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",
+      "prettier/@typescript-eslint"
+    ],
+    "rules": {
+       "@typescript-eslint/no-empty-function": "off"
+    },
+    "plugins": ["@typescript-eslint", "jest"]
+}
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,140 @@
+name: Test
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+jobs:
+
+  build:
+    name: Build
+
+    strategy:
+      matrix:
+        runs-on: [ubuntu-latest, macos-latest, windows-latest]
+      fail-fast: false
+
+    runs-on: ${{ matrix.runs-on }}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set Node.js 12.x
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
+
+    - name: npm install
+      run: npm install
+
+    - 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
+
+    # 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    
+        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
+
+    # Upload a single file artifact
+    - name: 'Upload artifact #1'
+      uses: ./
+      with:
+        name: 'Artifact-A'
+        path: path/to/dir-1/file1.txt
+
+    # Upload using a wildcard pattern, name should default to 'artifact' if not provided
+    - name: 'Upload artifact #2'
+      uses: ./
+      with:
+        path: path/**/dir*/
+
+    # Upload a directory that contains a file that will be uploaded with GZip
+    - name: 'Upload artifact #3'
+      uses: ./
+      with:
+        name: 'GZip-Artifact'
+        path: path/to/dir-3/
+
+    # 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@v1
+      with:
+        name: 'Artifact-A'
+        path: some/new/path
+
+    - name: 'Verify Artifact #1'
+      run: |
+        $file = "some/new/path/file1.txt"
+        if(!(Test-Path -path $file))
+        {
+            Write-Error "Expected file does not exist"
+        }
+        if(!((Get-Content $file) -ceq "Lorem ipsum dolor sit amet"))
+        {
+            Write-Error "File contents of downloaded artifact are incorrect"
+        }
+      shell: pwsh
+
+    # Download Artifact #2 and verify the correctness of the content
+    - name: 'Download artifact #2'
+      uses: actions/download-artifact@v1
+      with:
+        name: 'artifact'
+        path: some/other/path
+
+    - name: 'Verify Artifact #2'
+      run: |
+        $file1 = "some/other/path/to/dir-1/file1.txt"
+        $file2 = "some/other/path/to/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
+
+    # Download Artifact #3 and verify the correctness of the content
+    - name: 'Download artifact #3'
+      uses: actions/download-artifact@v1
+      with:
+        name: 'GZip-Artifact'
+        path: gzip/artifact/path
+
+    # Because a directory was used as input during the upload the parent directories, path/to/dir-3/, should not be included in the uploaded artifact
+    - name: 'Verify Artifact #3'
+      run: |
+        $gzipFile = "gzip/artifact/path/gzip.txt"
+        if(!(Test-Path -path $gzipFile))
+        {
+            Write-Error "Expected file do not exist"
+        }
+        if(!((Get-Content $gzipFile) -ceq "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"))
+        {
+            Write-Error "File contents of downloaded artifact is incorrect"
+        }
+      shell: pwsh
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+lib/
+__tests__/_temp/
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,11 @@
+{
+    "printWidth": 80,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "bracketSpacing": false,
+    "arrowParens": "avoid",
+    "parser": "typescript"
+  }
diff --git a/README.md b/README.md
@@ -1,45 +1,149 @@
-# upload-artifact
+# Upload-Artifact v2
 
-This uploads artifacts from your workflow.
+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)
+- 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)
 
-Basic:
+### Upload an Individual File
 ```yaml
 steps:
-- uses: actions/checkout@v1
+- uses: actions/checkout@v2
 
 - run: mkdir -p path/to/artifact
 
 - run: echo hello > path/to/artifact/world.txt
 
-- uses: actions/upload-artifact@v1
+- uses: actions/upload-artifact@v2
+  with:
+    name: my-artifact
+    path: path/to/artifact/world.txt
+```
+
+### Upload an Entire Directory
+
+```yaml
+- uses: actions/upload-artifact@v2
+  with:
+    name: my-artifact
+    path: path/to/artifact/ # or path/to/artifact
+```
+
+### Upload using a Wildcard Pattern:
+```yaml
+- uses: actions/upload-artifact@v2
   with:
     name: my-artifact
-    path: path/to/artifact
+    path: path/**/[abc]rtifac?/*
 ```
 
+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.
+
+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 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@v1
+- uses: actions/upload-artifact@v2
   if: failure()
   with:
     name: my-artifact
-    path: path/to/artifact
+    path: path/to/artifact/
+```
+
+### Uploading without an artifact name
+
+You can upload an artifact without specifying a name
+```yaml
+- uses: actions/upload-artifact@v2
+  with:
+    path: path/to/artifact/world.txt
+```
+
+If not provided, `artifact` will be used as the default name which will manifest itself in the UI after upload.
+
+### Uploading to the same artifact
+
+Each artifact behaves as a file share. Uploading to the same artifact multiple times in the same workflow can overwrite and append already uploaded files
+
+```yaml
+- run: echo hi > world.txt
+- uses: actions/upload-artifact@v2
+  with:
+    path: world.txt
+
+- run: echo howdy > extra-file.txt
+- uses: actions/upload-artifact@v2
+  with:
+    path: extra-file.txt
+
+- run: echo hello > world.txt
+- uses: actions/upload-artifact@v2
+  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`).
+
+### Environment Variables and Tilde Expansion
+
+You can use `~` in the path input as a substitute for `$HOME`. Basic tilde expansion is supported.
+
+```yaml
+  - run: |	
+      mkdir -p ~/new/artifact
+      echo hello > ~/new/artifact/world.txt
+  - uses: actions/upload-artifact@v2
+    with:	
+      name: 'Artifacts-V2'	
+      path: '~/new/**/*'
 ```
 
+Environment variables along with context expressions can also be used for input. For documentation see [context and expression syntax](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions).
+
+```yaml
+    env:
+      name: my-artifact
+    steps:
+    - run: |	
+        mkdir -p ${{ github.workspace }}/artifact
+        echo hello > ${{ github.workspace }}/artifact/world.txt
+    - uses: actions/upload-artifact@v2
+      with:	
+        name: ${{ env.name }}-name	
+        path: ${{ github.workspace }}/artifact/**/*
+```
 
 ## Where does the upload go?
 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. 
 
+## Additional Documentation
+
+See [persisting workflow data using artifacts](https://help.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts) for additional examples and tips.
+
+See extra documentation for the [@actions/artifact](https://github.com/actions/toolkit/blob/master/packages/artifact/docs/additional-information.md) package that is used internally regarding certain behaviors and limitations.
 
 # License