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/codefresh-yaml/what-is-the-codefresh-yaml.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,11 +63,11 @@ steps:
63
63
[step-contents]
64
64
{% endhighlight %}
65
65
66
-
You must define a step type for each step. Each step uses Docker images and containers as facilitators for execution. For example, the[**Freestyle**]({{site.baseurl}}/docs/codefresh-yaml/steps/freestyle/) step spins up a container and executes the specified shell commands from the YAML file.
66
+
You must define a step type for each step, unless you are using a[freestyle step]({{site.baseurl}}/docs/codefresh-yaml/steps/freestyle/). Each step uses Docker images and containers as facilitators for execution. For example, the[**Freestyle**]({{site.baseurl}}/docs/codefresh-yaml/steps/freestyle/) step spins up a container and executes the specified shell commands from the YAML file.
67
67
68
68
The step names should be unique within the same pipeline. This mainly affects the visualization of the pipeline when it runs.
69
69
70
-
Each step produces a resource, which you can reference in other steps, and are executed in real-time. For example, a[**Freestyle**]({{site.baseurl}}/docs/codefresh-yaml/steps/freestyle/) step can reference an image that was produced by a[**Build**]({{site.baseurl}}/docs/codefresh-yaml/steps/build/) step. This allows you to chain steps together and create highly-customized builds.
70
+
Each step produces a resource, which you can[reference](https://github.com/codefresh-contrib/python-flask-sample-app/blob/master/codefresh.yml#L23) in other steps, and are executed in real-time. For example, a[**Freestyle**]({{site.baseurl}}/docs/codefresh-yaml/steps/freestyle/) step can reference an image that was produced by a[**Build**]({{site.baseurl}}/docs/codefresh-yaml/steps/build/) step. This allows you to chain steps together and create highly-customized builds.
|[Freestyle]({{site.baseurl}}/docs/codefresh-yaml/steps/freestyle/)| Executes one or more shell commands in a container similar to`docker run`.|
82
82
|[Build]({{site.baseurl}}/docs/codefresh-yaml/steps/build/)| Builds a Docker image like`docker build`.|
83
-
|[Push]({{site.baseurl}}/docs/codefresh-yaml/steps/push/)| Pushes a Docker image toa Docker registry similar to`docker tag` and`docker push`.|
83
+
|[Push]({{site.baseurl}}/docs/codefresh-yaml/steps/push/)| Pushes a Docker image toan external registry similar to`docker tag` and`docker push`.|
84
84
|[Git Clone]({{site.baseurl}}/docs/codefresh-yaml/steps/git-clone/)| Overrides the default git clone behavior.|
85
85
|[Composition]({{site.baseurl}}/docs/codefresh-yaml/steps/composition/)| Starts a Docker Composition like`docker-compose`. Discarded once pipelines finishes.|
86
86
|[Launch Composition]({{site.baseurl}}/docs/codefresh-yaml/steps/launch-composition/)| Starts a long term Docker composition that stays up after the end of the pipeline.|
@@ -110,7 +110,7 @@ You can also validate the pipeline yaml outside of the UI by using the [Codefres
Copy file name to clipboardExpand all lines: _docs/learn-by-example/nodejs/lets-chat.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,10 @@ toc: true
11
11
Let’s Chat is self-hosted chat app for small to big teams.
12
12
This tutorial will walk you through the process of adding the following:
13
13
-`Build step` - that will build docker image for your let’s chat app.
14
-
-`Push to registry step` - that will push your image to docker hub.
15
14
-`Unit Test step` - A freestyle step that runs the unit test of the demo chat after the build.
16
15
-`Composition step` - This step will run a composition which use your chat image from the build step, docker image of curl and check if your application is responsive. It will do so by printing "works" if a curl command to our app at port 5000 succeed.
17
16
18
-
##Looking around
17
+
##Example Pipeline
19
18
In the root of this repository you'll find a file named codefresh.yml, this is our build descriptor and it describes the different steps that comprise our process. Let's quickly review the contents of this file: