-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
51 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,49 @@ | ||
# action-zip | ||
Action for zipping files easily | ||
|
||
> Action for zipping files easily | ||
## Usage | ||
|
||
The only requirement is to use the official `actions/checkout@v2` first so the zip action has access to the repo files. | ||
|
||
```yaml | ||
name: Zip Files | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
zip-files: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: papeloto/action-zip@v1 | ||
with: | ||
files: dist/ manifest.json | ||
dest: result.zip | ||
``` | ||
In this example, after a release is published, a new file named `result.zip` will be created with both the file `manifest.json` and the folder `dist` (files included). | ||
|
||
## Inputs | ||
|
||
#### `files` | ||
|
||
Files or directories to zip. | ||
|
||
- **Required:** Yes | ||
|
||
#### `dest` | ||
|
||
Name of the output zip file. | ||
|
||
- **Required:** No | ||
- **Default:** result.zip | ||
|
||
#### `recursive` | ||
|
||
Whether to add subdirectories to simply zip all files to the root. | ||
|
||
- **Required:** No | ||
- **Default:** true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,15 @@ | ||
name: "Zip Files" | ||
description: "Action for zipping files easily" | ||
inputs: | ||
github-token: | ||
description: "GitHub Token" | ||
required: true | ||
files: | ||
description: "Files or directories to zip" | ||
required: true | ||
dest: | ||
description: "Name of output zip file" | ||
default: "result.zip" | ||
recursive: | ||
description: "Whether to add subdirectories to simply zip all files to the root" | ||
default: true | ||
runs: | ||
using: "node12" | ||
main: "dist/index.js" |