https://github.com/crazy-max/ghaction-upx

GitHub Action for UPX, the Ultimate Packer for eXecutables
https://github.com/crazy-max/ghaction-upx

actions github-actions upx

Last synced: 18 days ago
JSON representation

GitHub Action for UPX, the Ultimate Packer for eXecutables

• Host: GitHub
• URL: https://github.com/crazy-max/ghaction-upx
• Owner: crazy-max
• License: mit
• Created: 2020-01-08T18:55:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T19:49:10.000Z (7 months ago)
• Last Synced: 2024-10-18T07:31:10.136Z (6 months ago)
• Topics: actions, github-actions, upx
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/upx-github-action
• Size: 10.5 MB
• Stars: 55
• Watchers: 4
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• awesome-actions - Compress with UPX - The Ultimate Packer for eXecutables. (Community Resources / Utility)
• fucking-awesome-actions - Compress with UPX - The Ultimate Packer for eXecutables. (Community Resources / Utility)
• awesome-workflows - Compress with UPX - The Ultimate Packer for eXecutables. (Community Resources / Utility)

README

        
[![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)

[![Test workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-upx/test.yml?branch=master&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)

[![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)

## About

GitHub Action for [UPX](https://github.com/upx/upx), the Ultimate Packer for eXecutables.

![Screenshot](.github/ghaction-upx.png)

___

* [Usage](#usage)

* [Customizing](#customizing)

  * [inputs](#inputs)

* [Limitation](#limitation)

* [Contributing](#contributing)

* [License](#license)

## Usage

```yaml

name: upx

on:

  push:

jobs:

  upx:

    runs-on: ubuntu-latest

    steps:

      -

        name: Checkout

        uses: actions/checkout@v4

      -

        name: Run UPX

        uses: crazy-max/ghaction-upx@v3

        with:

          version: latest

          files: |

            ./bin/*.exe

          args: -fq

```

If you just want to install UPX:

```yaml

name: upx

on:

  push:

jobs:

  upx:

    runs-on: ubuntu-latest

    steps:

      -

        name: Checkout

        uses: actions/checkout@v4

      -

        name: Install UPX

        uses: crazy-max/ghaction-upx@v3

        with:

          install-only: true

      -

        name: UPX version

        run: upx --version

```

## Customizing

### inputs

The following inputs can be used as `step.with` keys

| Name           | Type   | Default  | Description                                                |

|----------------|--------|----------|------------------------------------------------------------|

| `version`      | String | `latest` | UPX version. Example: `v3.95`                              |

| `files`        | String |          | Newline-delimited list of path globs for files to compress |

| `args`         | String |          | Arguments to pass to UPX                                   |

| `install-only` | String | `false`  | Just install UPX                                           |

## Limitation

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).

## Contributing

Want to contribute? Awesome! The most basic way to show your support is to star

the project, or to raise issues. 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!

Thanks again for your support, it is much appreciated! :pray:

## License

MIT. See `LICENSE` for more details.