ghaction-upx/README.md

✨ About

GitHub Action for UPX, the Ultimate Packer for eXecutables.

🚀 Usage

Below is a simple snippet to use this action. A live example is also available for this repository.

name: upx

on:
  pull_request:
  push:

jobs:
  upx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@master
      -
        name: Run UPX
        uses: crazy-max/ghaction-upx@master
        with:
          version: latest
          file: ./bin/mybinary
          args: -fq

💅 Customizing

inputs

Following inputs can be used as step.with keys

Name	Type	Default	Description
version	String	latest	UPX version. Example: 3.95
file	String		File to compress
args	String		Arguments to pass to UPX

⚠️ Limitation

This action is only available for Linux and Windows virtual environments.

🤝 How can I help ?

All kinds of contributions are welcome 🙌! 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 👏 or by making a Paypal donation to ensure this journey continues indefinitely! 🚀

Thanks again for your support, it is much appreciated! 🙏

📝 License

MIT. See LICENSE for more details.