You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/integrations/github-actions.md
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ In order to use a Github action in Codefresh you need to make sure that the foll
30
30
31
31
1. The[Github action](https://github.com/marketplace?type=actions) you have selected is Docker based and has a self-contained and valid Dockerfile
32
32
1. You have read the documentation of the Github action and know what arguments/input it requires
33
-
1. You have at least one Docker registry connected to your Codefresh account.
33
+
34
34
35
35
Also notice that since Github actions are created by the community, it is your responsibility to filter and curate any Github actions that you wish to use in Codefresh pipelines. If for example you use a Github action, and then it is removed by its creator, the Codefresh pipeline that uses it will break as well.
36
36
@@ -41,7 +41,7 @@ Also notice that since Github actions are created by the community, it is your r
41
41
Codefresh offers a github-action-to-codefresh step converter. This converter has two functions
42
42
43
43
1. When you create your pipeline it will analyze the Github action and try to find what arguments it requires. You must then fill the values needed by yourself
44
-
1. When the pipeline runs, it will automatically find the Dockerfile of the Github action, build it, push it in theDocker registry that you specify and then use it as a standard Codefresh step.
44
+
1. When the pipeline runs, it will automatically find the Dockerfile of the Github action, build it and make available thedocker image in any subsequent step in the same pipeline.
45
45
46
46
All this process is automatic. You just need to make sure that all arguments/inputs of the Github action as provided using[pipeline variables]({{site.baseurl}}/docs/configure-ci-cd-pipeline/pipelines/#creating-new-pipelines),[shared configuration]({{site.baseurl}}/docs/configure-ci-cd-pipeline/shared-configuration/) or any other standard mechanism you already use in Codefresh.
47
47
@@ -73,18 +73,16 @@ Then click on the Github action that you want to use in your pipeline. On the ri
This YAML snippet is a template and the following need to be filled under the`arguments` block:
83
+
This YAML snippet is a template and you need to fill the`env` block under the`arguments` block:
84
+
The required environment variables are specific to each Github action so check the documentation of the action itself.
84
85
85
-
*`env` - a list of arguments. They are specific to each Github action so check the documentation of the action itself
86
-
*`registry` - the name of a[registry connected to Codefresh]({{site.baseurl}}/docs/docker-registries/external-docker-registries/). You can find the names in your[integrations page](https://g.codefresh.io/account-admin/account-conf/integration/registry)
87
-
*`registry_repo` - the repository/account that you wish to use in the registry for storing the Github action. In the case of Dockerhub it is your Dockerhub username, for the Codefresh registry it is your Codefresh username and so on.
88
86
89
87
In the example above we are using the Snyk Github action. By visiting the[documentation page](https://github.com/marketplace/actions/snyk-cli-action) we find that this action expects a`SNYK_TOKEN` as input.
90
88
@@ -115,8 +113,6 @@ steps:
115
113
envs:
116
114
- SNYK_TOKEN: '${{SNYK_TOKEN}}'
117
115
cmd: test alpine@latest
118
-
registry: dockerhub
119
-
registry_repo: codefreshplugins
120
116
{% endraw %}
121
117
{% endhighlight %}
122
118
@@ -143,7 +139,6 @@ Once the pipeline reaches the Github action step, the converter will do automati
143
139
144
140
1. Find the Dockerfile of the Github action
145
141
1. Build the Dockerfile
146
-
1. Push the resulting image to the connected Codefresh registry
147
142
1. Take the resulting image and insert it as Codefresh step
148
143
1. Pass the environment variables as arguments to the Github action
Copy file name to clipboardExpand all lines: _docs/whats-new/whats-new.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ Recent Codefresh updates:
16
16
- New variable`CF_BRANCH_TAG_NORMALIZED_LOWER_CASE` -[documentation]({{site.baseurl}}/docs/codefresh-yaml/variables/#system-provided-variables)
17
17
- Trigger a Kubernetes Deployment from a Dockerhub Push Event -[documentation]({{site.baseurl}}/docs/yaml-examples/examples/trigger-a-k8s-deployment-from-docker-registry/)
18
18
- Uploading or Downloading from a Google Storage Bucket -[documentation]({{site.baseurl}}/docs/yaml-examples/examples/uploading-or-downloading-from-gs/)
19
+
- Use Github actions no longer requires a Registry -[documentation]({{site.baseurl}}/docs/integrations/github-actions/#how-it-works)