mirror of
https://code.forgejo.org/actions/upload-artifact.git
synced 2024-12-23 12:36:00 +01:00
chore: expand prettier and ESLint globs
This commit is contained in:
parent
055b8b3f04
commit
d9291ac874
17 changed files with 300 additions and 301 deletions
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"env": { "node": true, "jest": true },
|
"env": {"node": true, "jest": true},
|
||||||
"parser": "@typescript-eslint/parser",
|
"parser": "@typescript-eslint/parser",
|
||||||
"parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
|
"parserOptions": {"ecmaVersion": 9, "sourceType": "module"},
|
||||||
"extends": [
|
"extends": [
|
||||||
"eslint:recommended",
|
"eslint:recommended",
|
||||||
"plugin:@typescript-eslint/eslint-recommended",
|
"plugin:@typescript-eslint/eslint-recommended",
|
||||||
|
|
2
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
2
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
|
@ -1,4 +1,4 @@
|
||||||
name: "🐛 Bug report"
|
name: '🐛 Bug report'
|
||||||
description: Let us know about a bug!
|
description: Let us know about a bug!
|
||||||
labels: ['bug']
|
labels: ['bug']
|
||||||
title: '[bug]'
|
title: '[bug]'
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
name: "📚 Documentation issues"
|
name: '📚 Documentation issues'
|
||||||
description: Make a suggestion to improve the documentation!
|
description: Make a suggestion to improve the documentation!
|
||||||
labels: ['documentation']
|
labels: ['documentation']
|
||||||
title: '[docs]'
|
title: '[docs]'
|
||||||
|
|
2
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
2
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
|
@ -1,4 +1,4 @@
|
||||||
name: "🎁 Feature request"
|
name: '🎁 Feature request'
|
||||||
description: Suggest a new feature/enhancement!
|
description: Suggest a new feature/enhancement!
|
||||||
labels: ['enhancement']
|
labels: ['enhancement']
|
||||||
title: '[feat req]'
|
title: '[feat req]'
|
||||||
|
|
8
.github/workflows/codeql-analysis.yml
vendored
8
.github/workflows/codeql-analysis.yml
vendored
|
@ -1,8 +1,9 @@
|
||||||
name: "Code scanning - action"
|
name: 'Code scanning - action'
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches-ignore: "dependabot/**"
|
branches-ignore:
|
||||||
|
- 'dependabot/**'
|
||||||
pull_request:
|
pull_request:
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '**.md'
|
- '**.md'
|
||||||
|
@ -11,7 +12,6 @@ on:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
CodeQL-Build:
|
CodeQL-Build:
|
||||||
|
|
||||||
# CodeQL runs on ubuntu-latest and windows-latest
|
# CodeQL runs on ubuntu-latest and windows-latest
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
@ -22,10 +22,10 @@ jobs:
|
||||||
# Initializes the CodeQL tools for scanning.
|
# Initializes the CodeQL tools for scanning.
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@v1
|
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
|
||||||
|
|
||||||
# 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
|
||||||
|
|
1
.github/workflows/test.yml
vendored
1
.github/workflows/test.yml
vendored
|
@ -10,7 +10,6 @@ on:
|
||||||
- '**.md'
|
- '**.md'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
build:
|
build:
|
||||||
name: Build
|
name: Build
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
dist/
|
dist/
|
||||||
lib/
|
lib/
|
||||||
node_modules/
|
node_modules/
|
||||||
|
.licenses/
|
||||||
|
|
|
@ -6,6 +6,5 @@
|
||||||
"singleQuote": true,
|
"singleQuote": true,
|
||||||
"trailingComma": "none",
|
"trailingComma": "none",
|
||||||
"bracketSpacing": false,
|
"bracketSpacing": false,
|
||||||
"arrowParens": "avoid",
|
"arrowParens": "avoid"
|
||||||
"parser": "typescript"
|
}
|
||||||
}
|
|
||||||
|
|
|
@ -14,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
|
||||||
Examples of behavior that contributes to creating a positive environment
|
Examples of behavior that contributes to creating a positive environment
|
||||||
include:
|
include:
|
||||||
|
|
||||||
* Using welcoming and inclusive language
|
- Using welcoming and inclusive language
|
||||||
* Being respectful of differing viewpoints and experiences
|
- Being respectful of differing viewpoints and experiences
|
||||||
* Gracefully accepting constructive criticism
|
- Gracefully accepting constructive criticism
|
||||||
* Focusing on what is best for the community
|
- Focusing on what is best for the community
|
||||||
* Showing empathy towards other community members
|
- Showing empathy towards other community members
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
advances
|
advances
|
||||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
* Public or private harassment
|
- Public or private harassment
|
||||||
* Publishing others' private information, such as a physical or electronic
|
- Publishing others' private information, such as a physical or electronic
|
||||||
address, without explicit permission
|
address, without explicit permission
|
||||||
* Other conduct which could reasonably be considered inappropriate in a
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
professional setting
|
professional setting
|
||||||
|
|
||||||
## Our Responsibilities
|
## Our Responsibilities
|
||||||
|
|
|
@ -32,8 +32,8 @@ Artifact related issues will be tracked in this repository so please do not open
|
||||||
6. Make sure your code is correctly formatted: `npm run format`
|
6. Make sure your code is correctly formatted: `npm run format`
|
||||||
7. Make sure your code passes linting: `npm run lint`
|
7. Make sure your code passes linting: `npm run lint`
|
||||||
8. Update `dist/index.js` using `npm run release`. This creates a single javascript file that is used as an entry-point for the action
|
8. Update `dist/index.js` using `npm run release`. This creates a single javascript file that is used as an entry-point for the action
|
||||||
7. Push to your fork and [submit a pull request][pr]
|
9. Push to your fork and [submit a pull request][pr]
|
||||||
8. Pat your self on the back and wait for your pull request to be reviewed and merged.
|
10. Pat your self on the back and wait for your pull request to be reviewed and merged.
|
||||||
|
|
||||||
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
||||||
|
|
||||||
|
|
34
README.md
34
README.md
|
@ -28,13 +28,13 @@ See [action.yml](action.yml)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- 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@v3
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
path: path/to/artifact/world.txt
|
path: path/to/artifact/world.txt
|
||||||
|
@ -152,10 +152,10 @@ With the following example, the available artifact (named `artifact` by default
|
||||||
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:
|
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
|
||||||
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: Accidentally upload to the same artifact via multiple jobs
|
||||||
|
@ -170,8 +170,8 @@ Each artifact behaves as a file share. Uploading to the same artifact multiple t
|
||||||
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@v3
|
||||||
with:
|
with:
|
||||||
name: my-artifact ${{ matrix.node-version }}
|
name: my-artifact ${{ matrix.node-version }}
|
||||||
path: ${{ github.workspace }}
|
path: ${{ github.workspace }}
|
||||||
```
|
```
|
||||||
|
@ -181,10 +181,10 @@ In the above example, four jobs will upload four different files to the same art
|
||||||
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@v3
|
||||||
with:
|
with:
|
||||||
name: Artifacts-V3
|
name: Artifacts-V3
|
||||||
path: ~/new/**/*
|
path: ~/new/**/*
|
||||||
|
@ -193,9 +193,9 @@ You can use `~` in the path input as a substitute for `$HOME`. Basic tilde expan
|
||||||
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:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
steps:
|
steps:
|
||||||
- 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
|
||||||
|
@ -208,7 +208,7 @@ Environment variables along with context expressions can also be used for input.
|
||||||
For environment variables created in other steps, make sure to use the `env` expression syntax
|
For environment variables created in other steps, make sure to use the `env` expression syntax
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- run: |
|
- run: |
|
||||||
mkdir testing
|
mkdir testing
|
||||||
echo "This is a file to upload" > testing/file.txt
|
echo "This is a file to upload" > testing/file.txt
|
||||||
|
@ -224,10 +224,10 @@ For environment variables created in other steps, make sure to use the `env` exp
|
||||||
Artifacts are retained for 90 days by default. You can specify a shorter retention period using the `retention-days` input:
|
Artifacts are retained for 90 days by default. You can specify a shorter retention period using the `retention-days` input:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: Create a file
|
- name: Create a file
|
||||||
run: echo "I won't live long" > my_file.txt
|
run: echo "I won't live long" > my_file.txt
|
||||||
|
|
||||||
- name: Upload Artifact
|
- name: Upload Artifact
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
|
@ -266,10 +266,10 @@ During a workflow run, files are uploaded and downloaded individually using the
|
||||||
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@v3
|
||||||
with:
|
with:
|
||||||
name: my-artifact
|
name: my-artifact
|
||||||
|
|
|
@ -9,4 +9,4 @@ module.exports = {
|
||||||
'^.+\\.ts$': 'ts-jest'
|
'^.+\\.ts$': 'ts-jest'
|
||||||
},
|
},
|
||||||
verbose: true
|
verbose: true
|
||||||
}
|
}
|
||||||
|
|
|
@ -7,9 +7,9 @@
|
||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"release": "ncc build src/upload-artifact.ts && git add -f dist/",
|
"release": "ncc build src/upload-artifact.ts && git add -f dist/",
|
||||||
"check-all": "concurrently \"npm:format-check\" \"npm:lint\" \"npm:test\" \"npm:build\"",
|
"check-all": "concurrently \"npm:format-check\" \"npm:lint\" \"npm:test\" \"npm:build\"",
|
||||||
"format": "prettier --write **/*.ts",
|
"format": "prettier --write .",
|
||||||
"format-check": "prettier --check **/*.ts",
|
"format-check": "prettier --check .",
|
||||||
"lint": "eslint **/*.ts",
|
"lint": "eslint .",
|
||||||
"test": "jest --testTimeout 10000"
|
"test": "jest --testTimeout 10000"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
|
|
|
@ -14,4 +14,4 @@
|
||||||
"lib": ["es6"]
|
"lib": ["es6"]
|
||||||
},
|
},
|
||||||
"exclude": ["node_modules", "**/*.test.ts"]
|
"exclude": ["node_modules", "**/*.test.ts"]
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue