-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,46 @@ | ||
# build-yadoms-action github action | ||
# build-yadoms-windows-action github action | ||
|
||
This action allow to generate a yadoms build for Windows using Github Actions. | ||
This action allow to generate a yadoms build for **Windows** using Github Actions. | ||
|
||
## Inputs | ||
|
||
|
||
### `buildImage` | ||
|
||
**required** The image to use for building Yadoms. | ||
|
||
### `registry` | ||
|
||
*optional* The registry where to pull image (default : ''). | ||
|
||
### `username` | ||
|
||
*optional* The registry username (default : '') | ||
|
||
### `password` | ||
|
||
*optional* The registry password (default : '') | ||
|
||
### `privileged` | ||
|
||
*optional* To run the container in privileged mode, set this input to "--privileged" | ||
|
||
### `entrypoint` | ||
|
||
* optional * The entrypoint override (default : C:\entrypoint_docker.cmd) | ||
*optional* The entrypoint override (default : C:\entrypoint_docker.cmd) | ||
|
||
### `param1`, `param2`, `param3`, `param4` | ||
|
||
* optional * Free parameters passed to docker container | ||
*optional* Free parameters passed to docker container | ||
|
||
## Outputs | ||
|
||
### `yadomsVersion` | ||
|
||
The current building yadoms full version, example : '2.5.0-beta.1' | ||
|
||
|
||
## Example usage | ||
|
||
- name: Yadoms build script | ||
uses: Yadoms/build-yadoms-windows-action@v1.beta1 | ||
|
||
uses: Yadoms/build-yadoms-windows-action@v2.0.0 | ||
|