actions/zip
1
0
Fork 0
mirror of https://github.com/montudor/action-zip.git synced 2024-11-21 23:50:59 -05:00
Code Issues Projects Releases Packages Wiki Activity

Reword usage to YAML and add more examples

Browse source
This commit is contained in:
Cees-Jan Kiewiet 2019-10-31 08:05:09 +01:00
parent 4f9e7e3758
commit a5be92e5b4
No known key found for this signature in database
GPG key ID: ED590A7FF6A79B5B
1 changed files with 66 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
README.md
View file

@ -4,11 +4,72 @@ This GitHub action exposes the zip command for use in building/archiving.
## Usage
An example action config is displayed below:
Zipping the directory `vendor` into `vendor.zip`:
```yaml
- uses: montudor/action-zip@v0.1.0
with:
args: zip -qq -r ./dir.zip ./dir
```
action "Zip" {
uses = "montudor/action-zip@v0.1.0"
args = "zip -r output.zip ./path_to_files"
}
Unzipping a `vendor.zip` file:
```yaml
- uses: montudor/action-zip@v0.1.0
with:
args: unzip -qq dir.zip -d ./dir
```
Reusing the same zip between steps in a `PHP` CI with unit and mutation tests:
*Note that we're putting the zip in the `vendor-zip` directory, this is required
because the artifact upload/download expects a directory not a file.*
```yaml
name: Continuous Integration
on:
push:
pull_request:
jobs:
composer-install:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- run: composer install --ansi --no-progress --no-interaction --prefer-dist
- run: mkdir vendor-zip
- uses: montudor/action-zip@v0.1.0
with:
args: zip -qq -r ./vendor-zip/vendor.zip ./vendor
- uses: actions/upload-artifact@master
with:
name: vendor
path: vendor-zip
tests:
needs: composer-install
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/download-artifact@master
with:
name: vendor
path: vendor-zip
- uses: montudor/action-zip@v0.1.0
with:
args: unzip -qq ./vendor-zip/vendor.zip -d ./vendor
- run: rm -Rf ./vendor-zip
- run: ./vendor/bin/phpunit
mutation:
needs: composer-install
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/download-artifact@master
with:
name: vendor
path: vendor-zip
- uses: montudor/action-zip@v0.1.0
with:
args: unzip -qq ./vendor-zip/vendor.zip -d ./vendor
- run: rm -Rf ./vendor-zip
- run: ./vendor/bin/infection
```