actions/ghaction-upx
1
0
Fork 0
mirror of https://github.com/crazy-max/ghaction-upx.git synced 2024-10-22 05:36:08 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add note about dependabot

Browse Source
This commit is contained in:
CrazyMax 2020-08-20 17:33:46 +02:00
parent 5b3b22175b
commit ac6f831c34
No known key found for this signature in database
GPG Key ID: 3248E46B6BB8C7F7
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -9,6 +9,16 @@
GitHub Action for [UPX](https://github.com/upx/upx), the Ultimate Packer for eXecutables. GitHub Action for [UPX](https://github.com/upx/upx), the Ultimate Packer for eXecutables.
___
* [Usage](#usage)
* [Customizing](#customizing)
* [inputs](#inputs)
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
* [Limitation](#limitation)
* [How can I help?](#how-can-i-help)
* [License](#license)
## Usage ## Usage
```yaml ```yaml
@ -46,11 +56,27 @@ Following inputs can be used as `step.with` keys
| `file` | String | | File to compress (**required**) | | `file` | String | | File to compress (**required**) |
| `args` | String | | Arguments to pass to UPX | | `args` | String | | Arguments to pass to UPX |
## Keep up-to-date with GitHub Dependabot
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem),
to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file:
```yaml
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
```
## Limitation ## 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). 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).
## How can I help ? ## How can I help?
All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon: You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) :clap: or by making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely! :rocket: All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon: You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) :clap: or by making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely! :rocket: