https://github.com/vimtor/action-zip
🗄️ Action for zipping files easily
https://github.com/vimtor/action-zip
Last synced: 5 months ago
JSON representation
🗄️ Action for zipping files easily
- Host: GitHub
- URL: https://github.com/vimtor/action-zip
- Owner: vimtor
- License: mit
- Created: 2020-03-20T21:31:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T08:06:41.000Z (almost 2 years ago)
- Last Synced: 2025-06-12T06:24:51.447Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 48.8 KB
- Stars: 88
- Watchers: 3
- Forks: 35
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action-zip
Action for zipping files and folders 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: vimtor/action-zip@v1.2
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, relative to GITHUB_WORKSPACE environmental variable.
- **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
If for example, you do the following:
```yaml
- uses: vimtor/action-zip@v1.2
with:
files: dist/ manifest.json
recursive: false
dest: result.zip
```
The folder `dist` is included with along with its files. By contrast, if `recurise: true` (by default) All the files inside the `dist` folder will be added at the root of the zip along with `manifest.json`
Also if you want a nested file at the root, `recursive: true` is your guy.
## Troubleshooting
If you want to check that the output is the desired one I recommend you to add the following step after zipping. You will be able to download the `result.zip` file.
```yaml
- uses: actions/upload-artifact@v1.1
with:
name: my-artifact
path: ${{ github.workspace }}/result.zip
```