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

Improve README

Browse source 
- Fix typos: the directory is `dir` and not `vendor` in the first examples.
- The `upload/download artifact` action supports uploading/downloading a single
  file. Maybe it didn't at the point this was written, but it does in v2.
- Do not remove the downloaded artifact.
This commit is contained in:
Ana María Martínez Gómez 2020-08-25 15:00:40 +02:00
parent dff12f2cc2
commit 3939e6da10
No known key found for this signature in database
GPG key ID: EACB9B4BC80C0347
1 changed files with 13 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -4,27 +4,24 @@ This GitHub action exposes the zip command for use in building/archiving. It is
## Usage ## Usage
Zipping the directory `vendor` into `vendor.zip`: Zipping the directory `dir` into `dir.zip`:
```yaml ```yaml
- uses: montudor/action-zip@v0.1.0 - uses: montudor/action-zip@v0.1.0
with: with:
args: zip -qq -r ./dir.zip ./dir args: zip -qq -r dir.zip dir
``` ```
Unzipping a `vendor.zip` file: Unzipping a `dir.zip` file:
```yaml ```yaml
- uses: montudor/action-zip@v0.1.0 - uses: montudor/action-zip@v0.1.0
with: with:
args: unzip -qq dir.zip -d ./dir args: unzip -qq dir.zip -d dir
``` ```
Reusing the same zip between steps in a `PHP` CI with unit and mutation tests: 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 ```yaml
name: Continuous Integration name: Continuous Integration
on: on:
@ -36,40 +33,34 @@ jobs:
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- run: composer install --ansi --no-progress --no-interaction --prefer-dist - run: composer install --ansi --no-progress --no-interaction --prefer-dist
- run: mkdir vendor-zip
- uses: montudor/action-zip@v0.1.0 - uses: montudor/action-zip@v0.1.0
with: with:
args: zip -qq -r ./vendor-zip/vendor.zip ./vendor args: zip -qq -r vendor.zip vendor
- uses: actions/upload-artifact@master - uses: actions/upload-artifact@v2
with: with:
name: vendor name: vendor.zip
path: vendor-zip
tests: tests:
needs: composer-install needs: composer-install
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- uses: actions/download-artifact@master - uses: actions/download-artifact@v2
with: with:
name: vendor name: vendor.zip
path: vendor-zip
- uses: montudor/action-zip@v0.1.0 - uses: montudor/action-zip@v0.1.0
with: with:
args: unzip -qq ./vendor-zip/vendor.zip -d ./vendor args: unzip -qq vendor.zip -d vendor
- run: rm -Rf ./vendor-zip
- run: ./vendor/bin/phpunit - run: ./vendor/bin/phpunit
mutation: mutation:
needs: composer-install needs: composer-install
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- uses: actions/download-artifact@master - uses: actions/download-artifact@v2
with: with:
name: vendor name: vendor.zip
path: vendor-zip
- uses: montudor/action-zip@v0.1.0 - uses: montudor/action-zip@v0.1.0
with: with:
args: unzip -qq ./vendor-zip/vendor.zip -d ./vendor args: unzip -qq vendor.zip -d vendor
- run: rm -Rf ./vendor-zip
- run: ./vendor/bin/infection - run: ./vendor/bin/infection
``` ```