This GitHub Action provides the functionality to compress or decompress files using various
compression formats including zip, tar, tgz, and tbz2. It is designed to be easy to use within
GitHub workflows for handling file compression and decompression tasks efficiently.
| Input | Description | Required |
|---|---|---|
command |
The operation to perform. It can be either "compress" or "decompress" | Yes |
source |
The source directory or file to compress or decompress. | Yes |
dest |
The destination directory or file for the output. If not provided, it defaults to the current working directory. | No |
format |
The compression format to use. Supported formats are zip, tar, tgz, and tbz2. |
Yes |
| Output | Description |
|---|---|
file_path |
The path to the compressed or decompressed file. |
You can use this action in your GitHub workflow by specifying the action with its required inputs.
This example demonstrates how to use the Compress-Decompress action to compress a directory:
name: Compress Files
on: [push]
jobs:
compress-job:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Compress Directory
uses: somaz94/compress-decompress@v1
with:
command: compress
source: ./data-folder
format: zip
- name: Upload Artifact
uses: actions/upload-artifact@v4
with:
name: compressed-data
path: ./data-folder.zipTo decompress files, you can modify the workflow like so:
name: Decompress Files
on: [push]
jobs:
decompress-job:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Download Artifact
uses: actions/download-artifact@v4
with:
name: compressed-data
- name: List contents in the workspace
run: ls -la ${{ github.workspace }}
- name: Decompress Directory
uses: somaz94/compress-decompress@v1
with:
command: decompress
source: ./data-folder.zip
format: zip
dest: './unpacked'
- name: Display Content of the Unpacked Files
run: |
ls -la ${{ github.workspace }}/unpacked
cat ${{ github.workspace }}/unpacked/data-folder
This project is licensed under the MIT License file for details.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent