Welcome

So, you've decided to try Codefresh? Welcome on board!

Using this repository we'll help you get up to speed with basic functionality such as: compiling, building Docker images and launching compositions.

This project uses Node Js to build an application which will eventually become a distributable Docker image.

Looking around

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:

Compiling and testing

To compile and test our code we use Codefresh's Freestyle step.

The Freestyle step basically let's you say "Hey, Codefresh! Here's a Docker image. Create a new container and run these commands for me, will ya?"

build-prj:
    type: build
    description: UC - build step
    image-name: codefreshio/auth-example
    dockerfile: Dockerfile
    tag: ${{CF_BRANCH}}

build-nginx:
    type: build
    image-name: codefreshio/nginx
    dockerfile: nginx/Dockerfile
    tag: ${{CF_BRANCH}}

The image field states which image should be used when creating the container (Similar to Travis CI's language or circlecis machine`).

The commands field is how you specify all the commands that you'd like to execute

Launching

This is where it gets real! Let's use Codefresh's Launch Composition step to run our composition within Codefresh!

Launching compositions within Codefresh means you have your very own staging area, at a click of a button!

inline-composition:
    type: launch-composition
    environmentName: 'env-composition-name'
    composition:
      version: '2'
      services:
        web:
          image: ${{build-prj}}
        auth:
          image: ${{build-nginx}}
          ports:
            - 80
          links:
            - web
          environment:
            USER: "admin"
            PASS: "admin"

Using the composition field, we direct Codefresh to the location if the docker-compose file in our repository.

Once the Launch Composition step has completed successfully, you'll be able to review and share your running composition in the Environments page.

Now that we've gotten a grip on the flow, let's get cracking!

Using This Example

To use this example:

• Fork this repository to your own [INSERT_SCM_SYSTEM (git, bitbucket)] account.
• Log in to Codefresh using your [INSERT_SCM_SYSTEM (git, bitbucket)] account.
• Click the Add Service button.
• Select the forked repository.
• Select the I have a Codefresh.yml file option.
• Complete the wizard.
• Go to the pipeline and provide the environment variables
• Rejoice!