Skip to content

Commit 7a23a0a

Browse files
Update README.md
1 parent 5b3ef05 commit 7a23a0a

File tree

1 file changed

+57
-59
lines changed

1 file changed

+57
-59
lines changed

README.md

Lines changed: 57 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -67,68 +67,66 @@ For each specific connection (such as jira) parameters can be provided explicitl
6767

6868

6969
### service
70-
- #### CF_HOST
71-
- **description**: The url for reaching you codefresh cluster runtime
72-
- required
73-
- ["example",["https://codefresh.yourdoamin.com:80"]]
74-
- #### CF_API_KEY
75-
- **description**: Codefresh user token - authenticating with the codefresh runtime.
76-
- required
70+
- #### CF_HOST
71+
- **description**: The url for reaching you codefresh cluster runtime
72+
- required
73+
- ["example",["https://codefresh.yourdoamin.com:80"]]
74+
- #### CF_API_KEY
75+
- **description**: Codefresh user token - authenticating with the codefresh runtime.
76+
- required
7777
### mandatory
78-
- #### CF_IMAGE
79-
- **description**: Image name reported
80-
- required
81-
- ["examples",["mydockerhub/pushedimage:fix"]]
82-
- #### CF_CONTAINER_REGISTRY_INTEGRATION
83-
- **description**: Registry integration name
84-
- #### CF_ENRICHERS
85-
- **description**: List of integrations for collecting metadata on the build image, specify blank for no integrated services, by default does both jira and git
86-
- ["examples",["jira, git"]]
87-
- #### CF_WORKFLOW_URL
88-
- **description**: Reported url of the workflow building the image.
89-
- ["examples",["https://github.com/saffi-codefresh/csdp-report-image-github-action/actions/runs/2389116616"]]
90-
- #### CF_WORKFLOW_NAME
91-
- **description**: Given workflow name parameter, Optional name to appear on codefresh platform page.
92-
- ["examples",["Staging build step"]]
93-
- #### CF_CI_TYPE
94-
- **description**: Name of integration type, used for filtering results by the reporting tool type
95-
- ["examples",["git-action","classic","jenkins",""]]
78+
- #### CF_IMAGE
79+
- **description**: Image name reported
80+
- required
81+
- ["examples",["mydockerhub/pushedimage:fix"]]
82+
- #### CF_CONTAINER_REGISTRY_INTEGRATION
83+
- **description**: Registry integration name
84+
- #### CF_ENRICHERS
85+
- **description**: List of integrations for collecting metadata on the build image, specify blank for no integrated services, by default does both jira and git
86+
- ["examples",["jira, git"]]
87+
- #### CF_WORKFLOW_URL
88+
- **description**: Reported url of the workflow building the image.
89+
- ["examples",["https://github.com/saffi-codefresh/csdp-report-image-github-action/actions/runs/2389116616"]]
90+
- #### CF_WORKFLOW_NAME
91+
- **description**: Given workflow name parameter, Optional name to appear on codefresh platform page.
92+
- ["examples",["Staging build step"]]
93+
- #### CF_CI_TYPE
94+
- **description**: Name of integration type, used for filtering results by the reporting tool type
95+
- ["examples",["git-action","classic","jenkins",""]]
9696
### git
97-
- #### CF_GIT_BRANCH
98-
- **description**: The git branch which is related for the commit
99-
- #### CF_GIT_REPO
100-
- **description**: The the git repository used for building the image
101-
- required
97+
- #### CF_GIT_BRANCH
98+
- **description**: The git branch which is related for the commit
99+
- #### CF_GIT_REPO
100+
- **description**: The the git repository used for building the image
101+
- required
102102
### explicit-git-setup
103-
- #### CF_GIT_PROVIDER
104-
- **description**: The git integration type use (i.e. github)
105-
- required
103+
- #### CF_GIT_PROVIDER
104+
- **description**: The git integration type use (i.e. github)
105+
- required
106106
### github
107-
- #### CF_GITHUB_TOKEN
108-
- **description**: When explicit authentication used: For github use, authenticate with a github-token
109-
- required
110-
- ["examples",["ghp_vVvA6oh5iCO...."]]
111-
- #### CF_GITHUB_API_URL
112-
- **description**: Specify github host api url
113-
- ["examples",["https://api.github.com"]]
107+
- #### CF_GITHUB_TOKEN
108+
- **description**: When explicit authentication used: For github use, authenticate with a github-token
109+
- required
110+
- ["examples",["ghp_vVvA6oh5iCO...."]]
111+
- #### CF_GITHUB_API_URL
112+
- **description**: Specify github host api url
113+
- ["examples",["https://api.github.com"]]
114114
### gitlab
115-
- #### CF_GITLAB_TOKEN
116-
- **description**: When explicit authentication used: For gitlab use, authenticate with a gitlab-token
117-
- required
118-
- ["examples",["glpat-CzJ...."]]
119-
- #### GITLAB_HOST_URL
120-
- **description**: Specify gitlab host url
121-
- ["examples",["https://gitlab.com"]]
115+
- #### CF_GITLAB_TOKEN
116+
- **description**: When explicit authentication used: For gitlab use, authenticate with a gitlab-token
117+
- required
118+
- ["examples",["glpat-CzJ...."]]
119+
- #### GITLAB_HOST_URL
120+
- **description**: Specify gitlab host url
121+
- ["examples",["https://gitlab.com"]]
122122
### jira
123-
- #### CF_JIRA_PROJECT_PREFIX
124-
- **description**: Jira prefix for identifying the ticket number to use
125-
- required
126-
- ["examples",["CR"]]
127-
- #### CF_JIRA_MESSAGE
128-
- **description**: the message
129-
- required
130-
- ["examples",["fix CR-11312 "]]
131-
- #### CF_JIRA_FAIL_ON_NOT_FOUND
132-
- **description**: Fail pipeline if 'issue' not found
133-
- #### CF_JIRA_INTEGRATION
134-
- **description**: When jira integration name is specified instead of providing explicit credentials
123+
- #### CF_JIRA_INTEGRATION
124+
- **description**: When jira integration name is specified instead of providing explicit credentials
125+
- #### CF_JIRA_PROJECT_PREFIX
126+
- **description**: Jira prefix for identifying the ticket number to use
127+
- required
128+
- ["examples",["CR"]]
129+
- #### CF_JIRA_MESSAGE
130+
- **description**: the message
131+
- required
132+
- ["examples",["fix CR-11312 "]]

0 commit comments

Comments
 (0)