120 lines
5.4 KiB
Markdown
120 lines
5.4 KiB
Markdown
<!--
|
|
|
|
********************************************************************************
|
|
|
|
WARNING:
|
|
|
|
DO NOT EDIT "haxe/README.md"
|
|
|
|
IT IS AUTO-GENERATED
|
|
|
|
(from the other files in "haxe/" combined with a set of templates)
|
|
|
|
********************************************************************************
|
|
|
|
-->
|
|
|
|
# Supported tags and respective `Dockerfile` links
|
|
|
|
- [`3.1.3`, `3.1` (*3.1/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/0f4f8783c73fb791c0265680df8bc851727d2297/3.1/Dockerfile)
|
|
- [`3.1.3-onbuild`, `3.1-onbuild` (*3.1/onbuild/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/e0f9cb5a3cc190acd42565113e3380b5853f5746/3.1/onbuild/Dockerfile)
|
|
- [`3.2.1`, `3.2` (*3.2/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/0f4f8783c73fb791c0265680df8bc851727d2297/3.2/Dockerfile)
|
|
- [`3.2.1-onbuild`, `3.2-onbuild` (*3.2/onbuild/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/e0f9cb5a3cc190acd42565113e3380b5853f5746/3.2/onbuild/Dockerfile)
|
|
- [`3.3.0-rc.1`, `3.3.0`, `3.3` (*3.3/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/0f4f8783c73fb791c0265680df8bc851727d2297/3.3/Dockerfile)
|
|
- [`3.3.0-rc.1-onbuild`, `3.3.0-onbuild`, `3.3-onbuild` (*3.3/onbuild/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/e0f9cb5a3cc190acd42565113e3380b5853f5746/3.3/onbuild/Dockerfile)
|
|
- [`3.4.2`, `3.4`, `latest` (*3.4/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/8e6c65a2d72c239e8ddaf5af9157bb146d71016d/3.4/Dockerfile)
|
|
- [`3.4.2-onbuild`, `3.4-onbuild` (*3.4/onbuild/Dockerfile*)](https://github.com/HaxeFoundation/docker-library-haxe/blob/8e6c65a2d72c239e8ddaf5af9157bb146d71016d/3.4/onbuild/Dockerfile)
|
|
|
|
# Quick reference
|
|
|
|
- **Where to get help**:
|
|
[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
|
|
|
|
- **Where to file issues**:
|
|
[https://github.com/HaxeFoundation/docker-library-haxe/issues](https://github.com/HaxeFoundation/docker-library-haxe/issues)
|
|
|
|
- **Maintained by**:
|
|
[the Haxe Foundation](https://github.com/HaxeFoundation/docker-library-haxe)
|
|
|
|
- **Published image artifact details**:
|
|
[repo-info repo's `repos/haxe/` directory](https://github.com/docker-library/repo-info/blob/master/repos/haxe) ([history](https://github.com/docker-library/repo-info/commits/master/repos/haxe))
|
|
(image metadata, transfer size, etc)
|
|
|
|
- **Image updates**:
|
|
[official-images PRs with label `library/haxe`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fhaxe)
|
|
[official-images repo's `library/haxe` file](https://github.com/docker-library/official-images/blob/master/library/haxe) ([history](https://github.com/docker-library/official-images/commits/master/library/haxe))
|
|
|
|
- **Source of this description**:
|
|
[docs repo's `haxe/` directory](https://github.com/docker-library/docs/tree/master/haxe) ([history](https://github.com/docker-library/docs/commits/master/haxe))
|
|
|
|
- **Supported Docker versions**:
|
|
[the latest release](https://github.com/docker/docker/releases/latest) (down to 1.6 on a best-effort basis)
|
|
|
|
# What is Haxe?
|
|
|
|
[Haxe](https://haxe.org) is an open source toolkit based on a modern, high level, strictly typed programming language, a cross-compiler, a complete cross-platform standard library and ways to access each platform's native capabilities.
|
|
|
|
The Haxe compiler can output a number of source and binary files. As of Haxe 3.4.0-rc.1, the Haxe compiler can target JavaScript, Java, C#, C++, Python, PHP, Flash SWF, ActionScript 3, Lua, and Neko.
|
|
|
|
|
|
|
|
# About this image
|
|
|
|
This image ships a minimal Haxe toolkit:
|
|
|
|
- the `haxe` compiler with its standard library
|
|
- the `haxelib` library manager
|
|
- the `neko` virtual machine
|
|
|
|
# How to use this image
|
|
|
|
The most straightforward way to use this image is to use a Haxe container as both the build and runtime environment. In your `Dockerfile`, writing something along the lines of the following will compile and run your project:
|
|
|
|
```dockerfile
|
|
FROM haxe:3.4
|
|
|
|
RUN mkdir -p /usr/src/app
|
|
WORKDIR /usr/src/app
|
|
|
|
# install dependencies
|
|
COPY *.hxml /usr/src/app/
|
|
RUN yes | haxelib install all
|
|
|
|
# compile the project
|
|
COPY . /usr/src/app
|
|
RUN haxe build.hxml
|
|
|
|
# run the output when the container starts
|
|
CMD ["neko", "Main.n"]
|
|
```
|
|
|
|
Then, build and run the Docker image:
|
|
|
|
```console
|
|
$ docker build -t my-haxe-app .
|
|
$ docker run -it --rm --name my-running-app my-haxe-app
|
|
```
|
|
|
|
## Using the onbuild variants
|
|
|
|
There are `onbuild` variants that include multiple `ONBUILD` triggers to perform all of the steps in the above Dockerfile, except there is no `CMD` instruction for running the compilation output.
|
|
|
|
Rewriting the above Dockerfile with `haxe:3.4-onbuild`, we will get:
|
|
|
|
```dockerfile
|
|
FROM haxe:3.4-onbuild
|
|
|
|
# run the output when the container starts
|
|
CMD ["neko", "Main.n"]
|
|
```
|
|
|
|
The `onbuild` variants assume the main compilation hxml file is named `build.hxml`. To use another hxml file, set the `BUILD_HXML` build argument during build:
|
|
|
|
```console
|
|
$ docker build -t my-haxe-app --build-arg BUILD_HXML=compile.hxml .
|
|
```
|
|
|
|
# License
|
|
|
|
View [license information](https://haxe.org/foundation/open-source.html) for the software contained in this image.
|