Skip to content

Commit f400d8a

Browse files
readme change (#31)
Co-authored-by: saffi <[email protected]>
1 parent c1615c3 commit f400d8a

File tree

3 files changed

+12
-22
lines changed

3 files changed

+12
-22
lines changed

README.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,16 @@
11
# csdp-report-image
2-
Report created image to CSDP, for CI tools use.
2+
This repository build a container image that Report created image to CSDP, for CI tools use.
3+
34
##Required
45
* CF_API_KEY
56
* CF_IMAGE
6-
## Required with Default
77
* CF_HOST: yourcluster.company.io
8+
9+
## Empty by Default
810
* CF_ENRICHERS: git, jira
9-
* default is empty
10-
* possible values several of: git, jira
11-
## Optional
12-
* CF_CONTAINER_REGISTRY_INTEGRATION: "quay-1"
13-
* default : empty would take the default
14-
* CF_INSECURE: true
15-
* default: false
16-
* CF_WORKFLOW_URL:
17-
* CF_LOGS_URL:
18-
### Optional section Git - specify if included in CF_ENRICHERS list
19-
* CF_GIT_BRANCH:
20-
* CF_GIT_SHA:
21-
* CF_GIT_REPO:
22-
### optional section Jira - specify if included in CF_ENRICHERS list
23-
* CF_JIRA_PROJECT_PREFIX: "CR"
24-
* CF_JIRA_MESSAGE: "${{ GIT_BRANCH }}"
25-
* CF_JIRA_INTEGRATION: "jira-1"
26-
* CF_JIRA_FAIL_ON_NOT_FOUND : "true"
11+
* specify enrich/integrate section to include.
12+
* CF_CI_TYPE: github-actions
13+
* specify the Calling type
14+
15+
## see field details at your installed cluster:
16+
* https://yourcluster.company.io/app-proxy/api/image-report

action.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ inputs:
44
VERSION:
55
description: specify client version
66
required: false
7-
default: 0.0.40
7+
default: 0.0.41
88
CF_API_KEY:
99
description: "Codefresh API KEY"
1010
required: true

service.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
name: csdp-report-image
2-
version: 0.0.40
2+
version: 0.0.41

0 commit comments

Comments
 (0)