@@ -35,99 +35,110 @@ Commit that resulted in the image being built
35
35
CF_CONTAINER_REGISTRY_INTEGRATION: "dockerhub"
36
36
CF_JIRA_INTEGRATION: "jira"
37
37
38
- CF_ENRICHERS: "jira, git"
39
38
CF_IMAGE: ${{ secrets.DOCKERHUB_USERNAME }}/my-image-name:tag
40
39
41
40
CF_GITHUB_TOKEN: ${{ secrets.GIT_TOKEN }}
42
41
43
42
#Jira issues that match
44
43
CF_JIRA_MESSAGE: "CR-12293"
45
44
CF_JIRA_PROJECT_PREFIX: "CR"
46
- uses: codefresh-io/csdp -report-image@0.0.47
45
+ uses: codefresh-io/codefresh -report-image@latest
47
46
```
48
47
49
48
50
49
# Complete List of Arguments
51
- ## Required
52
- * CF_API_KEY
53
- * CF_IMAGE
54
- * CF_HOST: yourcluster.company.io
55
-
56
- ## Empty by Default
57
- * CF_ENRICHERS: git, jira
58
- * specify enrich/integrate section to include.
59
- * CF_CI_TYPE: github-actions
60
- * specify the Calling type
61
-
62
- ## Sections
63
- The environment variables are divided to sections and the use is controlled by the CF_ENRICHERS.
64
- For each specific connection (such as jira) parameters can be provided explicitly or by naming the integration
65
- * either use single var CF_JIRA_INTEGRATION (provide the name) or specify all variables in explicit-jira-setup
66
- * Bellow is the list of all the CF_ environment variables.
67
-
68
-
69
50
### 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
77
- ### 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",""]]
51
+ - #### CF_HOST
52
+ - ** description** : Name of runtime to implement the enrichment
53
+ - required
54
+ - [ "example",[ "https://codefresh.yourdoamin.com:80" ]]
55
+ - ** default** : [ runtime_host_url]
56
+ - #### CF_API_KEY
57
+ - ** description** : Codefresh API key
58
+ - required
59
+ - secret
60
+ ### general
61
+ - #### CF_IMAGE
62
+ - ** description** : Image path to enrich
63
+ - required
64
+ - [ "examples",[ "mydockerhub/pushedimage: fix "]]
65
+ - ** default** : [ full image path here, including tag]
66
+ - #### CF_CONTAINER_REGISTRY_INTEGRATION
67
+ - ** description** : Name of Container registry integration
68
+ - #### CF_WORKFLOW_URL
69
+ - ** description** : The reported URL of the workflow that builds the image.
70
+ - [ "examples",[ "https://github.com/saffi-codefresh/csdp-report-image-github-action/actions/runs/2389116616" ]]
71
+ - ** default** : [ URL of the workflow that builds the image]
72
+ - #### CF_WORKFLOW_NAME
73
+ - ** description** : The name assigned to the workflow that builds the image. When defined, the name is displayed in the Codefresh platform.
74
+ - [ "examples",[ "Staging build step"]]
75
+ - #### CF_CI_TYPE
76
+ - ** description** : Name of integration type, used for filtering results by the reporting tool type
77
+ - [ "examples",[ "git-action","classic","jenkins",""]]
96
78
### 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
79
+ - #### CF_GIT_BRANCH
80
+ - ** description** : The git branch which is related for the commit
81
+ - #### CF_GIT_REPO
82
+ - ** description** : The the git repository used for building the image
83
+ - required
102
84
### explicit-git-setup
103
- - #### CF_GIT_PROVIDER
104
- - ** description** : The git integration type use (i.e. github)
105
- - required
85
+ - #### CF_GIT_PROVIDER
86
+ - ** description** : The git integration type use (i.e. github)
87
+ - required
106
88
### 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" ]]
89
+ - #### CF_GITHUB_TOKEN
90
+ - ** description** : GitHub Access token
91
+ - required
92
+ - [ "examples",[ "ghp_vVvA6oh5iCO...."]]
93
+ - secret
94
+ - ** default** : [ github-personal-access-token]
95
+ - #### CF_GITHUB_API_URL
96
+ - ** description** : Specify github host api url
97
+ - [ "examples",[ "https://api.github.com" ]]
114
98
### 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" ]]
99
+ - #### CF_GITLAB_TOKEN
100
+ - ** description** : When explicit authentication used: For gitlab use, authenticate with a gitlab-token
101
+ - required
102
+ - [ "examples",[ "glpat-CzJ...."]]
103
+ - secret
104
+ - #### CF_GITLAB_HOST_URL
105
+ - ** description** : Specify gitlab host url
106
+ - [ "examples",[ "https://gitlab.com" ]]
107
+ ### bitbucket
108
+ - #### CF_BITBUCKET_USERNAME
109
+ - ** description** : Bitbucket username
110
+ - required
111
+ - #### CF_BITBUCKET_PASSWORD
112
+ - ** description** : Bitbucket password
113
+ - required
114
+ - secret
115
+ ### bitbucketServer
116
+ - #### CF_BITBUCKET_USERNAME
117
+ - ** description** : Bitbucket server username
118
+ - required
119
+ - #### CF_BITBUCKET_PASSWORD
120
+ - ** description** : Bitbucket server password
121
+ - required
122
+ - secret
123
+ - #### CF_BITBUCKET_HOST_URL
124
+ - ** description** : Bitbucket server host url
125
+ - required
126
+ - [ "examples",[ "https://bitbucket-server:7990" ]]
122
127
### jira
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 "]]
128
+ - #### CF_JIRA_INTEGRATION
129
+ - ** description** : Name of Jira integration
130
+ - ** default** : [ jira-registry-integration-name]
131
+ - #### CF_JIRA_PROJECT_PREFIX
132
+ - ** description** : Jira project filter
133
+ - required
134
+ - [ "examples",[ "CR"]]
135
+ - ** default** : [ jira-project-prefix]
136
+ - #### CF_JIRA_MESSAGE
137
+ - ** description** : String starting with the issue ID to associate with image
138
+ - required
139
+ - [ "examples",[ "fix CR-11312 "]]
140
+ - ** default** : [ issue id]
141
+ - #### CF_JIRA_FAIL_ON_NOT_FOUND
142
+ - ** description** : When enabled, Fail the image report when the specified Jira issue is not found.
143
+ - [ "examples",[ "true"]]
133
144
0 commit comments