ghaction-upx/README.md

79 lines
3.0 KiB
Markdown
Raw Normal View History

2020-01-08 14:26:34 -07:00
[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-upx.svg?style=flat-square)](https://github.com/crazy-max/ghaction-upx/releases/latest)
[![GitHub marketplace](https://img.shields.io/badge/marketplace-upx--github--action-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/upx-github-action)
2020-05-06 13:17:47 -06:00
[![Test workflow](https://img.shields.io/github/workflow/status/crazy-max/ghaction-upx/test?label=test&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-upx/actions?workflow=test)
[![Codecov](https://img.shields.io/codecov/c/github/crazy-max/ghaction-upx?logo=codecov&style=flat-square)](https://codecov.io/gh/crazy-max/ghaction-upx)
2020-01-08 14:26:34 -07:00
[![Become a sponsor](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github&style=flat-square)](https://github.com/sponsors/crazy-max)
[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](https://www.paypal.me/crazyws)
2020-01-23 07:12:43 -07:00
## About
2020-01-08 14:26:34 -07:00
GitHub Action for [UPX](https://github.com/upx/upx), the Ultimate Packer for eXecutables.
2022-05-26 15:59:55 -06:00
If you are interested, [check out](https://github.com/crazy-max?tab=repositories&q=ghaction&type=source&language=&sort=) my other :octocat: GitHub Actions!
![Screenshot](.github/ghaction-upx.png)
2020-08-20 09:33:46 -06:00
___
* [Usage](#usage)
* [Customizing](#customizing)
* [inputs](#inputs)
* [Limitation](#limitation)
2021-07-31 21:13:07 -06:00
* [Contributing](#contributing)
2020-08-20 09:33:46 -06:00
* [License](#license)
2020-01-23 07:12:43 -07:00
## Usage
2020-01-08 14:26:34 -07:00
```yaml
name: upx
on:
push:
jobs:
upx:
runs-on: ubuntu-latest
steps:
-
name: Checkout
2022-05-26 15:47:48 -06:00
uses: actions/checkout@v3
2020-01-08 14:26:34 -07:00
-
name: Run UPX
2022-05-26 15:33:59 -06:00
uses: crazy-max/ghaction-upx@v2
2020-01-08 14:26:34 -07:00
with:
version: latest
files: |
./bin/*.exe
2020-01-08 14:26:34 -07:00
args: -fq
```
2020-01-23 07:12:43 -07:00
## Customizing
2020-01-08 14:26:34 -07:00
### inputs
Following inputs can be used as `step.with` keys
2020-05-11 11:25:43 -06:00
| Name | Type | Default | Description |
|---------------|---------|-----------|---------------------------------|
| `version` | String | `latest` | UPX version. Example: `v3.95` |
| `files` | String | | Newline-delimited list of path globs for files to compress (**required**) |
2020-05-11 11:25:43 -06:00
| `args` | String | | Arguments to pass to UPX |
2020-01-08 14:26:34 -07:00
2020-01-23 07:12:43 -07:00
## Limitation
2020-01-17 01:42:14 -07:00
This action is only available for Linux and Windows [virtual environments](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources).
2021-07-31 21:13:07 -06:00
## Contributing
Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. If
you want to open a pull request, please read the [contributing guidelines](.github/CONTRIBUTING.md).
2020-01-08 14:26:34 -07:00
2021-07-31 21:13:07 -06:00
You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) or by
making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely!
2020-01-08 14:26:34 -07:00
Thanks again for your support, it is much appreciated! :pray:
2020-01-23 07:12:43 -07:00
## License
2020-01-08 14:26:34 -07:00
MIT. See `LICENSE` for more details.