Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nukdokplex/autohotkey-build
GitHub Action for building AutoHotkey scripts
https://github.com/nukdokplex/autohotkey-build
ahk ahk2exe autohotkey cicd github-actions
Last synced: 30 days ago
JSON representation
GitHub Action for building AutoHotkey scripts
- Host: GitHub
- URL: https://github.com/nukdokplex/autohotkey-build
- Owner: nukdokplex
- Created: 2023-02-12T06:58:33.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-11T21:18:24.000Z (almost 2 years ago)
- Last Synced: 2024-10-28T17:09:56.069Z (about 2 months ago)
- Topics: ahk, ahk2exe, autohotkey, cicd, github-actions
- Language: AutoHotkey
- Homepage: https://www.autohotkey.com/boards/viewtopic.php?t=113828
- Size: 60.5 KB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AutoHotkey Builder Action
GitHub Action for building [AHK](https://autohotkey.com/) scripts with `AHK2Exe`.
Consider supporting this project. You can buy me a cup of tea (I don't drink coffee).
- Bitcoin: [bc1qmr5m0z4p0gzqnfrztamrrpmgkw79725dsqdp03](bitcoin:BC1QMR5M0Z4P0GZQNFRZTAMRRPMGKW79725DSQDP03)
- Ethereum: 0xb0627eBDb226b4D972661637091573596c5B3B7a
## Attention
This action is designed **ONLY** for running in Windows Environment. It uses Windows binaries and runs in PowerShell. **You have been warned!**
By the way, AutoHotkey is also only available on Windows. Why do you want to compile your scripts on other platforms?
## Synopsis
This action was inspired by implementation of [this GitHub Action](https://github.com/nekocodeX/GitHub-Action-Ahk2Exe) from [@nekocodeX](https://github.com/nekocodeX), so the original idea belongs to him/her. I would be very proud if he/she joined the development of this project too.
This action, unlike the original idea, is intended to be more flexible and more fail-safe. And this action is the only one by these parameters in its niche.
The mechanism of this action can be broken down into four main steps:
1. Downloading required binaries, such as [AutoHotkey](https://github.com/AutoHotkey/AutoHotkey), [AHK2Exe](https://github.com/AutoHotkey/Ahk2Exe), [UPX](https://github.com/upx/upx) (if needed). All these binaries are downloaded from their official repositories.
2. Unpacking binaries and setup environment for successful build. All related files are located in `./._ahk`.
3. Building you AutoHotkey scripts with this environment.
4. Cleaning up.
## Usage example
Let's suppose that your scripts are in the root of your repository. Then after checkout they will be in the current working directory. Also let's suppose that you want to build in `./build`. Lets see how we can deal with it:
```yaml
name: Build
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
build:
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Build with AHK v1.1.22.01
uses: nukdokplex/[email protected]
with:
version: v1.1.22.01
x64: true
x86: true
compression: upx
in: ""
out: build
icon: "icons"
- name: Do domething with builded scripts
shell: pwsh
run: |
ls build
```
## Action input parameters
|Parameter name|Parameter description|Required|Defaults to|
|-|-|-|-|
|version|The version of AutoHotkey to be used (must be the version from the official AutoHotkey repository, e.g. "v1.1.29.01").|`false`|`latest`|
|x64|Specifies whether to compile the 64-bit version.|`false`|`true`|
|x86|Specifies whether to compile the 32-bit version.|`false`|`false`|
|x64_suffix|Specifies suffix for the 64-bit version out file.|`false`|`_x64`|
|x86_suffix|Specifies suffix for the 32-bit version out file.|`false`|`_x86`|
|compression|Specifies which compression method to use. "none" - do not use compression, "upx" - use UPX compression. There is no MPRESS 'cause it's discontinued. Don't try to use it, it won't work.|`false`|`none`|
|in|Specifies a folder with scripts or a single script to be compiled. If you specify a folder, files with the extensions ".ahk", ".ahk2" will be taken. Recursive search in folder is not present.|`false`|Current Working Directory|
|out|Specifies the folder for output files.|`false`|`build`|
|icon|Specifies icons. If you pass a single file, it will apply to all scripts. If you pass a folder, an icon with the same name will be used for each script. For example, the script named `test.ahk` will use the file `test.ico` in that folder.|`false`| |
## Thanks for making this possible
Many thanks to [@nekocodeX](https://github.com/nekocodeX) for this great idea!
Github Action [`robinraju/release-downloader`](https://github.com/robinraju/release-downloader) for cool action that got rid of the headache about downloading releases from GitHub.