An open API service indexing awesome lists of open source software.

https://github.com/fx31337/mql-compile-action

Compiles MQL programs via GitHub Actions
https://github.com/fx31337/mql-compile-action

compile forex github-actions metatrader mql

Last synced: 3 months ago
JSON representation

Compiles MQL programs via GitHub Actions

Awesome Lists containing this project

README

          

# MQL Compile Action

[![Release][github-release-image]][github-release-link]
[![Status][gha-image-action-master]][gha-link-action-master]
[![Status][gha-image-lint-master]][gha-link-lint-master]
[![Status][gha-image-test-master]][gha-link-test-master]
[![Telegram Channel][tg-channel-image]][tg-channel-link]
[![Telegram Chat][tg-chat-image]][tg-chat-link]
[![Edit][gh-edit-badge]][gh-edit-link]

This GitHub Action compiles MQL programs.

For full documentation, please read: [GitHub Actions Documentation](https://help.github.com/en/actions).

## Usage

This action is only supported on [Windows images](https://github.com/actions/virtual-environments).

### Latest release

```yaml
runs-on: windows-latest
steps:
- uses: fx31337/mql-compile-action@v2
```

### Specific release

```yaml
runs-on: windows-latest
steps:
- uses: fx31337/mql-compile-action@v2.0.0
```

Note: Check *Releases* for more details.

### Latest development version

```yaml
runs-on: windows-latest
steps:
- uses: fx31337/mql-compile-action@master
```

### Overriding default inputs

```yaml
runs-on: windows-latest
steps:
- uses: fx31337/mql-compile-action@master
with:
path: 'path/Dummy.mq5'
include: '.'
log-file: 'results.log'
ignore-warnings: true
mt-path: my/platform/path
verbose: true
```

*Note: From v2 releases, this action doesn't install platform by default.*

## Inputs

### `path` (string)

Path to folder or file to compile.

Default: `.` (all files in the current folder are compiled).

### `path-ignore` (string)

Path to folder or file for compiler to ignore.

Default: `**/*.mqh` (all .mqh files are ignored by default).

### `include` (string)

Path to search for includes files.

Default: ``.

### `mt-path` (string)

Platform path to use. Default: `.`.

### `ignore-warnings` (bool)

Whether to ignore compilation warnings.

### `log-file` (string)

Specifies log filename for compilation messages.

### `syntax-only` (bool)

Whether to skip generating binary file and only check for syntax issues. Default: *false*.

### `init-platform` (bool)

Whether to run terminal(64).exe which downloads general-purpose MQL4/5 includes, example scripts and EAs.

It is required if you want to use e.g., `#include ` and so on.

### `verbose` (bool)

Enables verbose mode (to print more messages). Default: *false*.

### `working-directory` (string)

Sets working directory where to run commands. Default: *.*.

### Support

- For bugs/features, raise a [new issue at GitHub](https://github.com/EA31337/MQL-Compile-Action/issues).
- Join our [Telegram group](https://t.me/EA31337) and [channel](https://t.me/EA31337_Announcements) for help.

[github-release-image]: https://img.shields.io/github/release/FX31337/MQL-Compile-Action.svg?logo=github
[github-release-link]: https://github.com/FX31337/MQL-Compile-Action/releases

[gh-edit-badge]: https://img.shields.io/badge/GitHub-edit-purple.svg?logo=github
[gh-edit-link]: https://github.dev/FX31337/MQL-Compile-Action

[tg-channel-image]: https://img.shields.io/badge/Telegram-news-0088CC.svg?logo=telegram
[tg-channel-link]: https://t.me/EA31337_News
[tg-chat-image]: https://img.shields.io/badge/Telegram-chat-0088CC.svg?logo=telegram
[tg-chat-link]: https://t.me/EA31337

[gha-link-action-master]: https://github.com/FX31337/MQL-Compile-Action/actions?query=workflow%3AAction+branch%3Amaster
[gha-image-action-master]: https://github.com/FX31337/MQL-Compile-Action/workflows/Action/badge.svg
[gha-link-lint-master]: https://github.com/FX31337/MQL-Compile-Action/actions?query=workflow%3ALint+branch%3Amaster
[gha-image-lint-master]: https://github.com/FX31337/MQL-Compile-Action/workflows/Lint/badge.svg
[gha-link-test-master]: https://github.com/FX31337/MQL-Compile-Action/actions?query=workflow%3ATest+branch%3Amaster
[gha-image-test-master]: https://github.com/FX31337/MQL-Compile-Action/workflows/Test/badge.svg