https://github.com/stefh/ghaction-compressfiles

A GitHub Action for compressing files using Brotli or GZip
https://github.com/stefh/ghaction-compressfiles

Last synced: 18 days ago
JSON representation

A GitHub Action for compressing files using Brotli or GZip

• Host: GitHub
• URL: https://github.com/stefh/ghaction-compressfiles
• Owner: StefH
• License: mit
• Created: 2020-06-22T18:34:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-04-02T10:18:25.000Z (over 2 years ago)
• Last Synced: 2024-04-13T21:01:23.220Z (7 months ago)
• Language: Shell
• Size: 10.7 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ghaction-CompressFiles

A GitHub Action for compressing files using Brotli or GZip compression.

## Why

In case you deploy your Blazor Web on GitHub Pages are have modified some files (*.js or *.html) and want to recompress these, use this GitHub Action.

## Usage

### Inputs

#### `path` (required)

The path to find the files. Default this is `.`

#### `extensions`

A comma separated list from all the file-extensions you want to compress. Default this is set to `.js,.css,.html,.json`

#### `tools`

A comma separated list from the compresion utilities you want to use. Valid values are `brotli` and `gzip`. Default both are used.

#### `depth`

Maximum folder depth to process. Default this is set to `3`.

#### `deterministicCompression`

When using "gzip"-compression, do not save or restore the original name and timestamp. 

Can be used for deterministic builds.

Default this is set to `"false"`.

### Example

``` yml

- name: CompressFiles

  uses: stefh/ghaction-CompressFiles@v2

  with:

    path: ${{ env.PUBLISH_DIR }}

    extensions: '.js,.css,.html'

    tools: 'brotli,gzip'

```