1
0

Compare commits

..

2 Commits

Author SHA1 Message Date
Konrad Pabjan
f0ad69f4df Extra Documentation 2020-03-19 14:05:58 +01:00
Konrad Pabjan
c9be818b8a 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
2020-03-13 14:44:44 +01:00
9 changed files with 862 additions and 1639 deletions

1
.gitattributes vendored
View File

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

View File

@@ -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.

View File

@@ -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

View File

@@ -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 }}

View File

@@ -1,22 +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)
- 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)
@@ -30,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
@@ -39,7 +26,7 @@ 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
@@ -47,7 +34,7 @@ steps:
### 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?/*
@@ -55,7 +42,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. Paths that begin with a wildcard character should be quoted to avoid being interpreted as YAML aliases.
Relative and absolute file paths are both allowed. Relative paths are rooted against the current working directory.
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.
@@ -64,7 +51,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
- uses: actions/upload-artifact@v2-preview
if: failure()
with:
name: my-artifact
@@ -75,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
```
@@ -88,17 +75,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
- 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
```
@@ -112,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/**/*'
@@ -127,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/**/*
@@ -137,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

897
dist/index.js vendored

File diff suppressed because it is too large Load Diff

1445
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -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": "^6.8.0",
"eslint-plugin-github": "^3.4.1",
"eslint-plugin-jest": "^23.8.2",
"glob": "^7.1.6",
"jest": "^25.3.0",
"jest-circus": "^25.3.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"
}
}

View File

@@ -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)