Compare commits
No commits in common. "main" and "v2.2.0" have entirely different histories.
@ -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"
|
|
||||||
}
|
|
@ -4,10 +4,13 @@
|
|||||||
"parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
|
"parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
|
||||||
"extends": [
|
"extends": [
|
||||||
"eslint:recommended",
|
"eslint:recommended",
|
||||||
|
"plugin:@typescript-eslint/eslint-recommended",
|
||||||
|
"plugin:@typescript-eslint/recommended",
|
||||||
"plugin:import/errors",
|
"plugin:import/errors",
|
||||||
"plugin:import/warnings",
|
"plugin:import/warnings",
|
||||||
"plugin:import/typescript",
|
"plugin:import/typescript",
|
||||||
"plugin:prettier/recommended"
|
"plugin:prettier/recommended",
|
||||||
|
"prettier/@typescript-eslint"
|
||||||
],
|
],
|
||||||
"rules": {
|
"rules": {
|
||||||
"@typescript-eslint/no-empty-function": "off"
|
"@typescript-eslint/no-empty-function": "off"
|
||||||
|
1
.github/CODEOWNERS
vendored
1
.github/CODEOWNERS
vendored
@ -1 +0,0 @@
|
|||||||
* @actions/artifacts-actions
|
|
63
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
63
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
@ -1,63 +0,0 @@
|
|||||||
name: "🐛 Bug report"
|
|
||||||
description: Let us know about a bug!
|
|
||||||
labels: ['bug']
|
|
||||||
title: '[bug]'
|
|
||||||
body:
|
|
||||||
- type: textarea
|
|
||||||
id: problem
|
|
||||||
attributes:
|
|
||||||
label: What happened?
|
|
||||||
description: |
|
|
||||||
Please provide a clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: expected
|
|
||||||
attributes:
|
|
||||||
label: What did you expect to happen?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: repro
|
|
||||||
attributes:
|
|
||||||
label: How can we reproduce it?
|
|
||||||
description: |
|
|
||||||
Please be minimal and precise as possible. If your repo/run is public, please include a URL so it is easier for us to investigate.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: additional
|
|
||||||
attributes:
|
|
||||||
label: Anything else we need to know?
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
id: version
|
|
||||||
attributes:
|
|
||||||
label: What version of the action are you using?
|
|
||||||
placeholder: vX.Y.Z
|
|
||||||
description: |
|
|
||||||
Please check the documentation first since different major versions can have different behaviors.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
id: environment
|
|
||||||
attributes:
|
|
||||||
label: What are your runner environments?
|
|
||||||
multiple: true
|
|
||||||
options:
|
|
||||||
- self-hosted
|
|
||||||
- linux
|
|
||||||
- window
|
|
||||||
- macos
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
id: ghes
|
|
||||||
attributes:
|
|
||||||
label: Are you on GitHub Enterprise Server? If so, what version?
|
|
||||||
placeholder: vX.Y
|
|
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
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.
|
5
.github/ISSUE_TEMPLATE/config.yml
vendored
5
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,5 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: 🙋 Ask a question
|
|
||||||
url: https://github.community/c/code-to-cloud/52
|
|
||||||
about: Please ask and answer questions on GitHub Support Community.
|
|
28
.github/ISSUE_TEMPLATE/documentation-issues.yml
vendored
28
.github/ISSUE_TEMPLATE/documentation-issues.yml
vendored
@ -1,28 +0,0 @@
|
|||||||
name: "📚 Documentation issues"
|
|
||||||
description: Make a suggestion to improve the documentation!
|
|
||||||
labels: ['documentation']
|
|
||||||
title: '[docs]'
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
❗ This is only for documentation updates for files in this repo, ie: `README.md`.
|
|
||||||
|
|
||||||
If you want to suggest changes for the [GitHub Docs](https://docs.github.com/), please [open an issue there](https://github.com/github/docs/issues/new/choose).
|
|
||||||
- type: textarea
|
|
||||||
id: affected
|
|
||||||
attributes:
|
|
||||||
label: What files would you like to change?
|
|
||||||
description: |
|
|
||||||
Please provide permalinks to the specified files and line numbers.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: suggested
|
|
||||||
attributes:
|
|
||||||
label: What are your suggested changes?
|
|
||||||
description: |
|
|
||||||
Give as much detail as you can to help us understand the changes you want to see.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
20
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
20
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
@ -1,20 +0,0 @@
|
|||||||
name: "🎁 Feature request"
|
|
||||||
description: Suggest a new feature/enhancement!
|
|
||||||
labels: ['enhancement']
|
|
||||||
title: '[feat req]'
|
|
||||||
body:
|
|
||||||
- type: textarea
|
|
||||||
id: feature
|
|
||||||
attributes:
|
|
||||||
label: What would you like to be added?
|
|
||||||
description: |
|
|
||||||
Please check existing issues to avoid making duplicates. Any duplicate issue will be closed immediately.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: reasoning
|
|
||||||
attributes:
|
|
||||||
label: Why is this needed?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
52
.github/workflows/check-dist.yml
vendored
52
.github/workflows/check-dist.yml
vendored
@ -1,52 +0,0 @@
|
|||||||
# `dist/index.js` is a special file in Actions.
|
|
||||||
# When you reference an action with `uses:` in a workflow,
|
|
||||||
# `index.js` is the code that will run.
|
|
||||||
# For our project, we generate this file through a build process
|
|
||||||
# from other source files.
|
|
||||||
# We need to make sure the checked-in `index.js` actually matches what we expect it to be.
|
|
||||||
name: Check dist/
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
check-dist:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Setup Node 16
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: 16.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
|
|
||||||
|
|
||||||
- name: Compare the expected and actual index.js files
|
|
||||||
run: git diff --ignore-all-space dist/index.js /tmp/index.js
|
|
||||||
id: diff
|
|
||||||
|
|
||||||
# If index.js was different than expected, upload the expected version as an artifact
|
|
||||||
- uses: actions/upload-artifact@v3
|
|
||||||
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
|
|
||||||
with:
|
|
||||||
name: index.js
|
|
||||||
path: dist/index.js
|
|
10
.github/workflows/codeql-analysis.yml
vendored
10
.github/workflows/codeql-analysis.yml
vendored
@ -2,8 +2,6 @@ name: "Code scanning - action"
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches-ignore: "dependabot/**"
|
|
||||||
pull_request:
|
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '**.md'
|
- '**.md'
|
||||||
schedule:
|
schedule:
|
||||||
@ -17,11 +15,11 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
# Initializes the CodeQL tools for scanning.
|
# Initializes the CodeQL tools for scanning.
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@v2
|
uses: github/codeql-action/init@v1
|
||||||
# Override language selection by uncommenting this and choosing your languages
|
# Override language selection by uncommenting this and choosing your languages
|
||||||
# with:
|
# with:
|
||||||
# languages: go, javascript, csharp, python, cpp, java
|
# languages: go, javascript, csharp, python, cpp, java
|
||||||
@ -29,7 +27,7 @@ jobs:
|
|||||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or 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)
|
# If this step fails, then you should remove it and run the build manually (see below)
|
||||||
- name: Autobuild
|
- name: Autobuild
|
||||||
uses: github/codeql-action/autobuild@v2
|
uses: github/codeql-action/autobuild@v1
|
||||||
|
|
||||||
# ℹ️ Command-line programs to run using the OS shell.
|
# ℹ️ Command-line programs to run using the OS shell.
|
||||||
# 📚 https://git.io/JvXDl
|
# 📚 https://git.io/JvXDl
|
||||||
@ -43,4 +41,4 @@ jobs:
|
|||||||
# make release
|
# make release
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
- name: Perform CodeQL Analysis
|
||||||
uses: github/codeql-action/analyze@v2
|
uses: github/codeql-action/analyze@v1
|
||||||
|
8
.github/workflows/licensed.yml
vendored
8
.github/workflows/licensed.yml
vendored
@ -1,12 +1,8 @@
|
|||||||
name: Licensed
|
name: Licensed
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push: {branches: main}
|
||||||
branches:
|
pull_request: {branches: main}
|
||||||
- main
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
|
28
.github/workflows/release-new-action-version.yml
vendored
28
.github/workflows/release-new-action-version.yml
vendored
@ -1,28 +0,0 @@
|
|||||||
name: Release new action version
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [released]
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
TAG_NAME:
|
|
||||||
description: 'Tag name that the major tag will point to'
|
|
||||||
required: true
|
|
||||||
|
|
||||||
env:
|
|
||||||
TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update_tag:
|
|
||||||
name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
|
|
||||||
environment:
|
|
||||||
name: releaseNewActionVersion
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Update the ${{ env.TAG_NAME }} tag
|
|
||||||
id: update-major-tag
|
|
||||||
uses: actions/publish-action@v0.2.1
|
|
||||||
with:
|
|
||||||
source-tag: ${{ env.TAG_NAME }}
|
|
||||||
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
|
|
29
.github/workflows/test.yml
vendored
29
.github/workflows/test.yml
vendored
@ -23,29 +23,28 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Setup Node 16
|
- name: Set Node.js 12.x
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v1
|
||||||
with:
|
with:
|
||||||
node-version: 16.x
|
node-version: 12.x
|
||||||
cache: 'npm'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: npm install
|
||||||
run: npm ci
|
run: npm install
|
||||||
|
|
||||||
- name: Compile
|
- name: Compile
|
||||||
run: npm run build
|
run: npm run build
|
||||||
|
|
||||||
|
- name: npm test
|
||||||
|
run: npm test
|
||||||
|
|
||||||
- name: Lint
|
- name: Lint
|
||||||
run: npm run lint
|
run: npm run lint
|
||||||
|
|
||||||
- name: Format
|
- name: Format
|
||||||
run: npm run format-check
|
run: npm run format-check
|
||||||
|
|
||||||
- name: Test
|
|
||||||
run: npm run test
|
|
||||||
|
|
||||||
# Test end-to-end by uploading two artifacts and then downloading them
|
# Test end-to-end by uploading two artifacts and then downloading them
|
||||||
- name: Create artifact files
|
- name: Create artifact files
|
||||||
run: |
|
run: |
|
||||||
@ -86,9 +85,11 @@ jobs:
|
|||||||
path/to/dir-[23]/*
|
path/to/dir-[23]/*
|
||||||
!path/to/dir-3/*.txt
|
!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
|
# Download Artifact #1 and verify the correctness of the content
|
||||||
- name: 'Download artifact #1'
|
- name: 'Download artifact #1'
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v1
|
||||||
with:
|
with:
|
||||||
name: 'Artifact-A'
|
name: 'Artifact-A'
|
||||||
path: some/new/path
|
path: some/new/path
|
||||||
@ -108,7 +109,7 @@ jobs:
|
|||||||
|
|
||||||
# Download Artifact #2 and verify the correctness of the content
|
# Download Artifact #2 and verify the correctness of the content
|
||||||
- name: 'Download artifact #2'
|
- name: 'Download artifact #2'
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v1
|
||||||
with:
|
with:
|
||||||
name: 'artifact'
|
name: 'artifact'
|
||||||
path: some/other/path
|
path: some/other/path
|
||||||
@ -129,7 +130,7 @@ jobs:
|
|||||||
|
|
||||||
# Download Artifact #3 and verify the correctness of the content
|
# Download Artifact #3 and verify the correctness of the content
|
||||||
- name: 'Download artifact #3'
|
- name: 'Download artifact #3'
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v1
|
||||||
with:
|
with:
|
||||||
name: 'GZip-Artifact'
|
name: 'GZip-Artifact'
|
||||||
path: gzip/artifact/path
|
path: gzip/artifact/path
|
||||||
@ -149,7 +150,7 @@ jobs:
|
|||||||
shell: pwsh
|
shell: pwsh
|
||||||
|
|
||||||
- name: 'Download artifact #4'
|
- name: 'Download artifact #4'
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v1
|
||||||
with:
|
with:
|
||||||
name: 'Multi-Path-Artifact'
|
name: 'Multi-Path-Artifact'
|
||||||
path: multi/artifact
|
path: multi/artifact
|
||||||
|
BIN
.licenses/npm/@actions/artifact.dep.yml
generated
BIN
.licenses/npm/@actions/artifact.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/@actions/core.dep.yml
generated
BIN
.licenses/npm/@actions/core.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/@actions/glob.dep.yml
generated
BIN
.licenses/npm/@actions/glob.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/@actions/http-client.dep.yml
generated
BIN
.licenses/npm/@actions/http-client.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/@actions/io.dep.yml
generated
BIN
.licenses/npm/@actions/io.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/@types/tmp.dep.yml
generated
Normal file
BIN
.licenses/npm/@types/tmp.dep.yml
generated
Normal file
Binary file not shown.
BIN
.licenses/npm/glob.dep.yml
generated
BIN
.licenses/npm/glob.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/minimatch.dep.yml
generated
BIN
.licenses/npm/minimatch.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/rimraf.dep.yml
generated
BIN
.licenses/npm/rimraf.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/tmp-promise.dep.yml
generated
BIN
.licenses/npm/tmp-promise.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/tmp.dep.yml
generated
BIN
.licenses/npm/tmp.dep.yml
generated
Binary file not shown.
BIN
.licenses/npm/uuid.dep.yml
generated
BIN
.licenses/npm/uuid.dep.yml
generated
Binary file not shown.
140
README.md
140
README.md
@ -1,4 +1,4 @@
|
|||||||
# Upload-Artifact v3
|
# Upload-Artifact v2
|
||||||
|
|
||||||
This uploads artifacts from your workflow allowing you to share data between jobs and store data once a workflow is complete.
|
This uploads artifacts from your workflow allowing you to share data between jobs and store data once a workflow is complete.
|
||||||
|
|
||||||
@ -25,16 +25,15 @@ Refer [here](https://github.com/actions/upload-artifact/tree/releases/v1) for th
|
|||||||
See [action.yml](action.yml)
|
See [action.yml](action.yml)
|
||||||
|
|
||||||
### Upload an Individual File
|
### Upload an Individual File
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
- run: mkdir -p path/to/artifact
|
- run: mkdir -p path/to/artifact
|
||||||
|
|
||||||
- run: echo hello > path/to/artifact/world.txt
|
- run: echo hello > path/to/artifact/world.txt
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: path/to/artifact/world.txt
|
path: path/to/artifact/world.txt
|
||||||
@ -43,25 +42,23 @@ steps:
|
|||||||
### Upload an Entire Directory
|
### Upload an Entire Directory
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: path/to/artifact/ # or path/to/artifact
|
path: path/to/artifact/ # or path/to/artifact
|
||||||
```
|
```
|
||||||
|
|
||||||
### Upload using a Wildcard Pattern
|
### Upload using a Wildcard Pattern
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: path/**/[abc]rtifac?/*
|
path: path/**/[abc]rtifac?/*
|
||||||
```
|
```
|
||||||
|
|
||||||
### Upload using Multiple Paths and Exclusions
|
### Upload using Multiple Paths and Exclusions
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: |
|
path: |
|
||||||
@ -72,21 +69,20 @@ steps:
|
|||||||
|
|
||||||
For supported wildcards along with behavior and documentation, see [@actions/glob](https://github.com/actions/toolkit/tree/main/packages/glob) which is used internally to search for files.
|
For supported wildcards along with behavior and documentation, see [@actions/glob](https://github.com/actions/toolkit/tree/main/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:
|
If a wildcard pattern is used, the path hierarchy will be preserved after the first wildcard pattern.
|
||||||
|
|
||||||
```
|
```
|
||||||
path/to/*/directory/foo?.txt =>
|
path/to/*/directory/foo?.txt =>
|
||||||
∟ path/to/some/directory/foo1.txt
|
∟ path/to/some/directory/foo1.txt
|
||||||
∟ path/to/some/directory/foo2.txt
|
∟ path/to/some/directory/foo2.txt
|
||||||
∟ path/to/other/directory/foo1.txt
|
∟ path/to/other/directory/foo1.txt
|
||||||
|
|
||||||
would be flattened and uploaded as =>
|
would be flattened and uploaded as =>
|
||||||
∟ some/directory/foo1.txt
|
∟ some/directory/foo1.txt
|
||||||
∟ some/directory/foo2.txt
|
∟ some/directory/foo2.txt
|
||||||
∟ other/directory/foo1.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.
|
||||||
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 affect 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.
|
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.
|
||||||
|
|
||||||
@ -94,10 +90,10 @@ The [@actions/artifact](https://github.com/actions/toolkit/tree/main/packages/ar
|
|||||||
|
|
||||||
### Customization if no files are found
|
### Customization if no files are found
|
||||||
|
|
||||||
If a path (or paths), result in no files being found for the artifact, the action will succeed but print out a warning. In certain scenarios it may be desirable to fail the action or suppress the warning. The `if-no-files-found` option allows you to customize the behavior of the action if no files are found:
|
If a path (or paths), result in no files being found for the artifact, the action will succeed but print out a warning. In certain scenarios it may be desirable to fail the action or suppress the warning. The `if-no-files-found` option allows you to customize the behavior of the action if no files are found.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: path/to/artifact/
|
path: path/to/artifact/
|
||||||
@ -109,7 +105,7 @@ If a path (or paths), result in no files being found for the artifact, the actio
|
|||||||
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):
|
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
|
```yaml
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
if: failure()
|
if: failure()
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
@ -119,9 +115,8 @@ To upload artifacts only when the previous step of a job failed, use [`if: failu
|
|||||||
### Uploading without an artifact name
|
### Uploading without an artifact name
|
||||||
|
|
||||||
You can upload an artifact without specifying a name
|
You can upload an artifact without specifying a name
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
path: path/to/artifact/world.txt
|
path: path/to/artifact/world.txt
|
||||||
```
|
```
|
||||||
@ -130,47 +125,46 @@ If not provided, `artifact` will be used as the default name which will manifest
|
|||||||
|
|
||||||
### Uploading to the same artifact
|
### Uploading to the same artifact
|
||||||
|
|
||||||
With the following example, the available artifact (named `artifact` by default if no name is provided) would contain both `world.txt` (`hello`) and `extra-file.txt` (`howdy`):
|
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
|
```yaml
|
||||||
- run: echo hi > world.txt
|
- run: echo hi > world.txt
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
path: world.txt
|
path: world.txt
|
||||||
|
|
||||||
- run: echo howdy > extra-file.txt
|
- run: echo howdy > extra-file.txt
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
path: extra-file.txt
|
path: extra-file.txt
|
||||||
|
|
||||||
- run: echo hello > world.txt
|
- run: echo hello > world.txt
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
path: world.txt
|
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`).
|
||||||
|
|
||||||
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:
|
> **_Warning:_** Be careful when uploading to the same artifact via multiple jobs as artifacts may become corrupted
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
node-version: [8.x, 10.x, 12.x, 13.x]
|
node-version: [8.x, 10.x, 12.x, 13.x]
|
||||||
steps:
|
steps:
|
||||||
- name: Create a file
|
- name: 'Create a file'
|
||||||
run: echo ${{ matrix.node-version }} > my_file.txt
|
run: echo ${{ matrix.node-version }} > my_file.txt
|
||||||
- name: Accidentally upload to the same artifact via multiple jobs
|
- name: 'Accidently upload to the same artifact via multiple jobs'
|
||||||
uses: actions/upload-artifact@v3
|
uses: 'actions/upload-artifact@v2'
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: ${{ github.workspace }}
|
path: ${{ github.workspace }}
|
||||||
```
|
```
|
||||||
|
|
||||||
> **_Warning:_** Be careful when uploading to the same artifact via multiple jobs as artifacts may become corrupted. When uploading a file with an identical name and path in multiple jobs, uploads may fail with 503 errors due to conflicting uploads happening at the same time. Ensure uploads to identical locations to not interfere with each other.
|
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.
|
||||||
|
|
||||||
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
|
```yaml
|
||||||
uses: actions/upload-artifact@v3
|
uses: 'actions/upload-artifact@v2'
|
||||||
with:
|
with:
|
||||||
name: my-artifact ${{ matrix.node-version }}
|
name: my-artifact ${{ matrix.node-version }}
|
||||||
path: ${{ github.workspace }}
|
path: ${{ github.workspace }}
|
||||||
@ -178,19 +172,19 @@ In the above example, four jobs will upload four different files to the same art
|
|||||||
|
|
||||||
### Environment Variables and Tilde Expansion
|
### Environment Variables and Tilde Expansion
|
||||||
|
|
||||||
You can use `~` in the path input as a substitute for `$HOME`. Basic tilde expansion is supported:
|
You can use `~` in the path input as a substitute for `$HOME`. Basic tilde expansion is supported.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- run: |
|
- run: |
|
||||||
mkdir -p ~/new/artifact
|
mkdir -p ~/new/artifact
|
||||||
echo hello > ~/new/artifact/world.txt
|
echo hello > ~/new/artifact/world.txt
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: Artifacts-V3
|
name: 'Artifacts-V2'
|
||||||
path: ~/new/**/*
|
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):
|
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
|
```yaml
|
||||||
env:
|
env:
|
||||||
@ -199,54 +193,18 @@ Environment variables along with context expressions can also be used for input.
|
|||||||
- run: |
|
- run: |
|
||||||
mkdir -p ${{ github.workspace }}/artifact
|
mkdir -p ${{ github.workspace }}/artifact
|
||||||
echo hello > ${{ github.workspace }}/artifact/world.txt
|
echo hello > ${{ github.workspace }}/artifact/world.txt
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: ${{ env.name }}-name
|
name: ${{ env.name }}-name
|
||||||
path: ${{ github.workspace }}/artifact/**/*
|
path: ${{ github.workspace }}/artifact/**/*
|
||||||
```
|
```
|
||||||
|
|
||||||
For environment variables created in other steps, make sure to use the `env` expression syntax
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
steps:
|
|
||||||
- run: |
|
|
||||||
mkdir testing
|
|
||||||
echo "This is a file to upload" > testing/file.txt
|
|
||||||
echo "artifactPath=testing/file.txt" >> $GITHUB_ENV
|
|
||||||
- uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: artifact
|
|
||||||
path: ${{ env.artifactPath }} # this will resolve to testing/file.txt at runtime
|
|
||||||
```
|
|
||||||
|
|
||||||
### Retention Period
|
|
||||||
|
|
||||||
Artifacts are retained for 90 days by default. You can specify a shorter retention period using the `retention-days` input:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Create a file
|
|
||||||
run: echo "I won't live long" > my_file.txt
|
|
||||||
|
|
||||||
- name: Upload Artifact
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: my-artifact
|
|
||||||
path: my_file.txt
|
|
||||||
retention-days: 5
|
|
||||||
```
|
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
## Where does the upload go?
|
## 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 an `Artifacts` dropdown which you can download items from. Here's a screenshot of what it looks like<br/>
|
||||||
At the bottom of the workflow summary page, there is a dedicated section for artifacts. Here's a screenshot of something you might see:
|
<img src="https://user-images.githubusercontent.com/16109154/72556687-20235a80-386d-11ea-9e2a-b534faa77083.png" width="375" height="140">
|
||||||
|
|
||||||
<img src="https://user-images.githubusercontent.com/16109154/103645952-223c6880-4f59-11eb-8268-8dca6937b5f9.png" width="700" height="300">
|
|
||||||
|
|
||||||
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 trashcan icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository.
|
||||||
|
|
||||||
The size of the artifact is denoted in bytes. The displayed artifact size denotes the raw uploaded artifact size (the sum of all the individual files uploaded during the workflow run for the artifact), not the compressed size. When you click to download an artifact from the summary page, a compressed zip is created with all the contents of the artifact and the size of the zip that you download may differ significantly from the displayed size. Billing is based on the raw uploaded size and not the size of the zip.
|
|
||||||
|
|
||||||
# Limitations
|
# Limitations
|
||||||
|
|
||||||
### Zipped Artifact Downloads
|
### Zipped Artifact Downloads
|
||||||
@ -263,31 +221,25 @@ During a workflow run, files are uploaded and downloaded individually using the
|
|||||||
|
|
||||||
### Maintaining file permissions and case sensitive files
|
### Maintaining file permissions and case sensitive files
|
||||||
|
|
||||||
If file permissions and case sensitivity are required, you can `tar` all of your files together before artifact upload. Post download, the `tar` file will maintain file permissions and case sensitivity:
|
If file permissions and case sensitivity are required, you can `tar` all of your files together before artifact upload. Post download, the `tar` file will maintain file permissions and case sensitivity.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: Tar files
|
- name: 'Tar files'
|
||||||
run: tar -cvf my_files.tar /path/to/my/directory
|
run: tar -cvf my_files.tar /path/to/my/directory
|
||||||
|
|
||||||
- name: Upload Artifact
|
- name: 'Upload Artifact'
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: my_files.tar
|
path: my_files.tar
|
||||||
```
|
```
|
||||||
|
|
||||||
### Too many uploads resulting in 429 responses
|
|
||||||
|
|
||||||
A very minute subset of users who upload a very very large amount of artifacts in a short period of time may see their uploads throttled or fail because of `Request was blocked due to exceeding usage of resource 'DBCPU' in namespace` or `Unable to copy file to server StatusCode=TooManyRequests`.
|
|
||||||
|
|
||||||
To reduce the chance of this happening, you can reduce the number of HTTP calls made during artifact upload by zipping or archiving the contents of your artifact before an upload starts. As an example, imagine an artifact with 1000 files (each 10 Kb in size). Without any modification, there would be around 1000 HTTP calls made to upload the artifact. If you zip or archive the artifact beforehand, the number of HTTP calls can be dropped to single digit territory. Measures like this will significantly speed up your upload and prevent uploads from being throttled or in some cases fail.
|
|
||||||
|
|
||||||
## Additional Documentation
|
## Additional Documentation
|
||||||
|
|
||||||
See [Storing workflow data as artifacts](https://docs.github.com/en/actions/advanced-guides/storing-workflow-data-as-artifacts) for additional examples and tips.
|
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/main/packages/artifact/docs/additional-information.md) package that is used internally regarding certain behaviors and limitations.
|
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
|
# License
|
||||||
|
|
||||||
The scripts and documentation in this project are released under the [MIT License](LICENSE).
|
The scripts and documentation in this project are released under the [MIT License](LICENSE)
|
||||||
|
@ -24,5 +24,5 @@ inputs:
|
|||||||
Minimum 1 day.
|
Minimum 1 day.
|
||||||
Maximum 90 days unless changed from the repository settings page.
|
Maximum 90 days unless changed from the repository settings page.
|
||||||
runs:
|
runs:
|
||||||
using: 'node16'
|
using: 'node12'
|
||||||
main: 'dist/index.js'
|
main: 'dist/index.js'
|
||||||
|
16753
dist/index.js
vendored
16753
dist/index.js
vendored
File diff suppressed because it is too large
Load Diff
17950
package-lock.json
generated
17950
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
38
package.json
38
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "upload-artifact",
|
"name": "upload-artifact",
|
||||||
"version": "3.0.0",
|
"version": "2.0.1",
|
||||||
"description": "Upload a build artifact that can be used by subsequent workflow steps",
|
"description": "Upload a build artifact that can be used by subsequent workflow steps",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@ -29,25 +29,25 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/actions/upload-artifact#readme",
|
"homepage": "https://github.com/actions/upload-artifact#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/artifact": "^1.1.2",
|
"@actions/artifact": "^0.4.0",
|
||||||
"@actions/core": "^1.10.0",
|
"@actions/core": "^1.2.3",
|
||||||
"@actions/glob": "^0.3.0",
|
"@actions/glob": "^0.1.0",
|
||||||
"@actions/io": "^1.1.2"
|
"@actions/io": "^1.0.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"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": "^3.4.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": "^26.1.0",
|
||||||
"jest-circus": "^29.3.1",
|
"jest-circus": "^26.1.0",
|
||||||
"prettier": "^2.8.1",
|
"prettier": "^2.0.4",
|
||||||
"ts-jest": "^29.0.3",
|
"ts-jest": "^25.3.1",
|
||||||
"typescript": "^4.9.4"
|
"typescript": "^3.8.3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,4 +1,3 @@
|
|||||||
/* eslint-disable no-unused-vars */
|
|
||||||
export enum Inputs {
|
export enum Inputs {
|
||||||
Name = 'name',
|
Name = 'name',
|
||||||
Path = 'path',
|
Path = 'path',
|
||||||
|
@ -31,18 +31,11 @@ async function run(): Promise<void> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
const s = searchResult.filesToUpload.length === 1 ? '' : 's'
|
|
||||||
core.info(
|
core.info(
|
||||||
`With the provided path, there will be ${searchResult.filesToUpload.length} file${s} uploaded`
|
`With the provided path, there will be ${searchResult.filesToUpload.length} file(s) uploaded`
|
||||||
)
|
)
|
||||||
core.debug(`Root artifact directory is ${searchResult.rootDirectory}`)
|
core.debug(`Root artifact directory is ${searchResult.rootDirectory}`)
|
||||||
|
|
||||||
if (searchResult.filesToUpload.length > 10000) {
|
|
||||||
core.warning(
|
|
||||||
`There are over 10,000 files in this artifact, consider creating an archive before upload to improve the upload performance.`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
const artifactClient = create()
|
const artifactClient = create()
|
||||||
const options: UploadOptions = {
|
const options: UploadOptions = {
|
||||||
continueOnError: false
|
continueOnError: false
|
||||||
@ -68,8 +61,8 @@ async function run(): Promise<void> {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} catch (error) {
|
} catch (err) {
|
||||||
core.setFailed((error as Error).message)
|
core.setFailed(err.message)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user