Skip to content
codefresh-io

GitHub Action

Codefresh pipeline runner

v7 Latest version
Use latest version
codefresh-io

Codefresh pipeline runner

Github action that runs codefresh pipeline

Installation

Copy and paste the following snippet into your .yml file.

- name: Codefresh pipeline runner
  uses: codefresh-io/[email protected]
Learn more about this action in codefresh-io/codefresh-pipeline-runner
Choose a version

Codefresh pipeline runner GitHub Action

Codefresh is a CI/CD platform that engineers actually love to use. The Codefresh pipeline runner GitHub action will trigger an existing Codefresh pipeline from a GitHub action.

It is based on the Codefresh CLI which can execute Codefresh pipelines remotely (using an API key for authentication). The Codefresh CLI is already available as a public Docker image, so creating a GitHub action with it is a trivial process.

Integrating Codefresh pipelines with GitHub actions

GitHub actions are a flexible way to respond to GitHub events and perform one or more tasks when a specific GitHub event happens. GitHub actions can also use Codefresh pipelines as a back-end resulting in a very powerful combination where the first action starts from GitHub, but Codefresh takes care of the actual compilation or deployment in a pipeline.

Prerequisites

Make sure that you have

How the Codefresh action works

The GitHub workflow is placed on the push event and therefore starts whenever a Git commit happens. The Workflow has a single action that starts the Codefresh pipeline runner.

The pipeline runner is a Docker image with the Codefresh CLI. It uses the Codefresh API token to authenticate to Codefresh and then calls a an existing pipeline via its trigger.

The result is that all the details from the Git push (i.e. the GIT hash) are transferred to the Codefresh pipeline that gets triggered remotely

How to use the Codefresh GitHub action

An example of workflow

name: run codefresh pipeline
on: push
jobs:
  build:
    runs-on: ubuntu-18.04
    steps:
      - name: Checkout
        uses: actions/[email protected]
        
      - name: 'run pipeline'
        uses: codefresh-io/[email protected]
        with:
          args: '-v key1=value1 -v key2=value2'
        env:
          PIPELINE_NAME: 'codefresh-pipeline'
          TRIGGER_NAME: 'codefresh-trigger'
          CF_API_KEY: ${{ secrets.CF_API_KEY }}
        id: run-pipeline

Env variables

Click the Done button to save your changes and commit.

Now next time you commit anything in your GitHub repository the Codefresh pipeline will also execute.

Outputs

The action will report if the pipeline execution was successful. For example, if your pipeline has unit tests that fail, by default, it will report the action failed. The logs from the pipeline will be streamed into the Github action console.