Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jano42 authored Feb 5, 2021
1 parent 1b69949 commit f745fab
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
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

0 comments on commit f745fab

Please sign in to comment.