Compare commits

...
11 Commits
6 changed files with 1453 additions and 804 deletions
+1
View File
@@ -0,0 +1 @@
* text=auto eol=lf
+3 -5
View File
@@ -1,13 +1,11 @@
name: Test
on:
push:
branches:
- v2-preview
branches:
- master
paths-ignore:
- '**.md'
pull_request:
branches:
- v2-preview
paths-ignore:
- '**.md'
@@ -18,7 +16,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 }}
+26 -13
View File
@@ -1,9 +1,22 @@
# Upload-Artifact v2 Preview
# Upload-Artifact v2
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)
@@ -17,7 +30,7 @@ steps:
- run: echo hello > path/to/artifact/world.txt
- uses: actions/upload-artifact@v2-preview
- uses: actions/upload-artifact@v2
with:
name: my-artifact
path: path/to/artifact/world.txt
@@ -26,7 +39,7 @@ steps:
### Upload an Entire Directory
```yaml
- uses: actions/upload-artifact@v2-preview
- uses: actions/upload-artifact@v2
with:
name: my-artifact
path: path/to/artifact/ # or path/to/artifact
@@ -34,7 +47,7 @@ steps:
### Upload using a Wildcard Pattern:
```yaml
- uses: actions/upload-artifact@v2-preview
- uses: actions/upload-artifact@v2
with:
name: my-artifact
path: path/**/[abc]rtifac?/*
@@ -42,7 +55,7 @@ steps:
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.
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.
@@ -51,7 +64,7 @@ The [@actions/artifact](https://github.com/actions/toolkit/tree/master/packages/
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-preview
- uses: actions/upload-artifact@v2
if: failure()
with:
name: my-artifact
@@ -62,7 +75,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-preview
- uses: actions/upload-artifact@v2
with:
path: path/to/artifact/world.txt
```
@@ -75,17 +88,17 @@ 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-preview
- uses: actions/upload-artifact@v2
with:
path: world.txt
- run: echo howdy > extra-file.txt
- uses: actions/upload-artifact@v2-preview
- uses: actions/upload-artifact@v2
with:
path: extra-file.txt
- run: echo hello > world.txt
- uses: actions/upload-artifact@v2-preview
- uses: actions/upload-artifact@v2
with:
path: world.txt
```
@@ -99,7 +112,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-preview
- uses: actions/upload-artifact@v2
with:
name: 'Artifacts-V2'
path: '~/new/**/*'
@@ -114,7 +127,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-preview
- uses: actions/upload-artifact@v2
with:
name: ${{ env.name }}-name
path: ${{ github.workspace }}/artifact/**/*
@@ -124,7 +137,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 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.
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
+482 -270
View File
File diff suppressed because it is too large Load Diff
+932 -507
View File
File diff suppressed because it is too large Load Diff
+9 -9
View File
@@ -29,23 +29,23 @@
},
"homepage": "https://github.com/actions/upload-artifact#readme",
"devDependencies": {
"@actions/artifact": "^0.2.0",
"@actions/artifact": "^0.3.1",
"@actions/core": "^1.2.3",
"@actions/glob": "^0.1.0",
"@actions/io": "^1.0.2",
"@types/jest": "^25.1.4",
"@types/node": "^12.12.30",
"@typescript-eslint/parser": "^2.23.0",
"@zeit/ncc": "^0.20.5",
"@types/jest": "^25.2.1",
"@types/node": "^13.11.1",
"@typescript-eslint/parser": "^2.27.0",
"@zeit/ncc": "^0.22.1",
"concurrently": "^5.1.0",
"eslint": "^6.8.0",
"eslint-plugin-github": "^3.4.1",
"eslint-plugin-jest": "^23.8.2",
"glob": "^7.1.6",
"jest": "^25.1.0",
"jest-circus": "^25.1.0",
"prettier": "^1.19.1",
"ts-jest": "^25.2.1",
"jest": "^25.3.0",
"jest-circus": "^25.3.0",
"prettier": "^2.0.4",
"ts-jest": "^25.3.1",
"typescript": "^3.8.3"
}
}