ghaction-upx/README.md

About

GitHub Action for UPX, the Ultimate Packer for eXecutables.

---

• Usage
• Customizing
  • inputs
• Limitation
• Contributing
• License

Usage

name: upx

on:
  push:

jobs:
  upx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Run UPX
        uses: crazy-max/ghaction-upx@v2
        with:
          version: latest
          files: |
            ./bin/*.exe            
          args: -fq

If you just want to install UPX:

name: upx

on:
  push:

jobs:
  upx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Install UPX
        uses: crazy-max/ghaction-upx@v2
        with:
          install-only: true
      -
        name: UPX version
        run: upx --version

Customizing

inputs

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.

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.

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.