Skip to content

Commit 99deb4a

Browse files
stauststaust
committed
adjust readme
1 parent fb486e5 commit 99deb4a

1 file changed

Lines changed: 25 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,11 @@ jobs:
4343
dockerpassword: ${{ secrets.DOCKER_PASSWORD }}
4444
# This is the name of the Docker image for your service.
4545
dockerimage: private/diablo-redbook
46+
# List of build-time variables
47+
dockerbuildargs: "ARG1='one',ARG2='two'"
48+
# Sets the target stage to build
49+
dockerbuildtarget: "runtime"
4650
# The additional arguments you need to build the docker image
47-
dockeradditionalbuildparams: "--target runtime --build-arg ARG1='one' --build-arg ARG2='two'"
4851
gitopstoken: ${{ secrets.GITOPS_TOKEN }}
4952
# The gitopsdev, gitopsstage and gitopsprod values are used to specify which files including the YAML path which should be updated with the new image.
5053
# ATTENTION 1: You must use |- to remove the final newline in the string, otherwise the GitHub Action will fail.
@@ -66,22 +69,24 @@ jobs:
6669

6770
## Inputs
6871

69-
| Name | Description | Default |
70-
| ---- | ----------- | ------- |
71-
| `dockerenabled` | Build and push the Docker Image | `true` |
72-
| `dockerregistry` | Docker Registry | `registry.staffbase.com`|
73-
| `dockerimage` | Docker Image | |
74-
| `dockerusername` | Username for the Docker Registry | |
75-
| `dockerpassword` | Password for the Docker Registry | |
76-
| `dockerfile` | Dockerfile | `./Dockerfile` |
77-
| `dockeradditionalbuildparams` | List of Docker Build Parameters like: "--target runtime --build-arg ARG1=one --build-arg ARG2=two" | |
78-
| `gitopsenabled` | Update the manifest files in the GitOps repository | `true` |
79-
| `gitopsorganization` | GitHub Organization for GitOps | `Staffbase` |
80-
| `gitopsrepository` | GitHub Repository for GitOps | `mops` |
81-
| `gitopsuser` | GitHub User for GitOps | `Staffbot` |
82-
| `gitopsemail` | GitHub User for GitOps | `staffbot@staffbase.com` |
83-
| `gitopstoken` | GitHub Token for GitOps | |
84-
| `gitopsdev` | Files which should be updated by the GitHub Action for DEV | |
85-
| `gitopsstage` | Files which should be updated by the GitHub Action for STAGE | |
86-
| `gitopsprod` | Files which should be updated by the GitHub Action for PROD | |
87-
| `workingdirectory` | The directory in which the GitOps action should be executed. The dockerfile variable should be relative to working directory. | `.` |
72+
| Name | Description | Default |
73+
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------|
74+
| `dockerenabled` | Build and push the Docker Image | `true` |
75+
| `dockerregistry` | Docker Registry | `registry.staffbase.com` |
76+
| `dockerimage` | Docker Image | |
77+
| `dockerusername` | Username for the Docker Registry | |
78+
| `dockerpassword` | Password for the Docker Registry | |
79+
| `dockerfile` | Dockerfile | `./Dockerfile` |
80+
| `dockeradditionalbuildparams` | List of Docker Build Parameters like: "--target runtime --build-arg ARG1=one --build-arg ARG2=two" | |
81+
| `dockerbuildargs` | List of build-time variables like: "ARG1=one,ARG2=two" | |
82+
| `dockerbuildtarget` | Sets the target stage to build like: "runtime" | |
83+
| `gitopsenabled` | Update the manifest files in the GitOps repository | `true` |
84+
| `gitopsorganization` | GitHub Organization for GitOps | `Staffbase` |
85+
| `gitopsrepository` | GitHub Repository for GitOps | `mops` |
86+
| `gitopsuser` | GitHub User for GitOps | `Staffbot` |
87+
| `gitopsemail` | GitHub User for GitOps | `staffbot@staffbase.com` |
88+
| `gitopstoken` | GitHub Token for GitOps | |
89+
| `gitopsdev` | Files which should be updated by the GitHub Action for DEV | |
90+
| `gitopsstage` | Files which should be updated by the GitHub Action for STAGE | |
91+
| `gitopsprod` | Files which should be updated by the GitHub Action for PROD | |
92+
| `workingdirectory` | The directory in which the GitOps action should be executed. The dockerfile variable should be relative to working directory. | `.` |

0 commit comments

Comments
 (0)