GitHub Actions

Connect your GitHub Actions pipelines to Codefresh

Codefresh Hosted GitOps can be used with any popular Continuous Integration (CI) solution, not just with Codefresh CI.

You can connect any external CI solution to Codefresh, such as GitHub Actions for example, to take care of common CI tasks such as building/testing/scanning source code, with Codefresh Hosted GitOps still responsible for the deployment, including image enrichment and reporting.
See Image enrichment with integrations.

Codefresh Marketplace GitHub Action

To support the integration between GitHub Actions and Codefresh, they have created a dedicated action in the Codefresh marketplace. The action combines image enrichment and reporting through integrations with Jira, and container registries such as DockerHub or Quay.

Use the action in the following manner:

  1. Create a GitHub Actions pipeline like you normally do.
  2. Use any existing CI actions for compiling code, running unit tests, security scanning etc.
  3. Place the final action in the pipeline as the “report image” action provided by Codefresh, copying the arguments and values from the GitHub Actions integration you set up in Codefresh.
  4. When the pipeline completes execution, Codefresh retrieves the information on the image that was built and its metadata (essentially the same data that Codefresh CI would send automatically).
  5. View the image in Codefresh in the Images dashboard, and in any GitOps deployment in which it is used.

Codefresh-GitHub Action integration arguments

The table describes the arguments required for GitHub Action-Codefresh integration.

Argument Description Required/Optional/Default
CF_HOST The URL to the cluster with the Codefresh runtime to integrate with. If you have more than one runtime, select the runtime from the list. Codefresh displays the URL of the selected runtime cluster. Required
CF_API_KEY The API key to authenticate the GitHub Actions user to Codefresh. Generate the key for the GitHub Action. Required
CF_CONTAINER_REGISTRY_INTEGRATION The name of the registry integration created in Codefresh to use with the GitHub Action. Optional
CF_JIRA_INTEGRATION The name of the Jira integration created in Codefresh to use for the GitHub Action. Relevant only if Jira enrichment is required for the image. If you don’t have a Jira integration, create a new integration (see Jira integration). When defined, CF_ENRICHERS must include jira. Optional
CF_IMAGE The name of the image to report to Codefresh. Required
CF_ENRICHERS The type or types of enrichment information to retrieve and add to the image. By default, empty. When enrichment information is required, can be either git, jira, or both. When an enricher type is defined, you must also define the required fields for the enrichment-type for Codefresh to retrieve information. Default
CF_WORKFLOW_URL The reported URL of the workflow that builds the image. Optional
CF_WORKFLOW_NAME The name assigned to the workflow that builds the image. When defined, the name is displayed in the Codefresh platform. Example, Staging step Optional
CF_GITHUB_TOKEN The token for Git integration. Required
CF_JIRA_PROJECT_PREFIX Relevant only when CF_ENRICHERS includes jira. The Jira project prefix that identifies the ticket number for which to retrieve information. Optional
CF_JIRA_MESSAGE Relevant only when CF_ENRICHERS includes jira. The Jira message for the CF_JIRA_PROJECT_PREFIX to add to the image. Optional

Connect a GitHub Action in Codefresh

Add a GitHub Action to Codefresh with the required arguments.

  1. In the Codefresh UI, go to Integrations.
  2. Select GitHub Actions, and then click Configure.
  3. Define the arguments for the GitHub Action. Review GitHub Action arguments.
    • For the CF_API_KEY, click Generate. Note down the token generated.
    • To create a container registry integration for DockerHub if you don’t have one, click Create Container Registry Integration, and then configure the settings. See Docker Hub integration.
    • To create a Jira integration, click Create Atlassian Jira Integration, and then configure the settings. See Jira integration.
  4. Enter this token in GitHub Actions as a secret with the name CF_API_KEY.
    Now you can reference it in all GitHub pipelines as you would any other secret.

GitHub Action integration for image enrichment

GitHub Action integration for image enrichment
  1. Copy the arguments and their values to the GitHub Action pipeline. See the example below for guidelines.

GitHub Actions pipeline example

Here is an example pipeline that uses GitHub Actions to build a container image, and the Codefresh action to enrich and report the resulting image to Codefresh.

Because a Jira integration account is configured in Codefresh, the step needs only the name for CF_JIRA_INTEGRATION, instead of explicit credentials CF_JIRA_API_TOKEN, CF_JIRA_HOST_URL, and CF_JIRA_EMAIL.

name: Docker Image CI

    branches: [ main ]
    branches: [ main ]
      name: test
    runs-on: ubuntu-latest
      - name: Checkout
        uses: actions/checkout@v3
      - name: Login to DockerHub
        uses: docker/login-action@v2
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
      - name: Build & push the Docker image
          CF_IMAGE: ${{ secrets.DOCKERHUB_USERNAME }}/build-by-github-action:0.0.1
        run: |
          docker build . --file Dockerfile --tag $CF_IMAGE && docker push $CF_IMAGE
          echo "Image should be accessible to your local machine (after docker login) by:"
          echo "docker pull $CF_IMAGE"
          docker pull $CF_IMAGE
          echo "On the next step, the report image would use the integration to pull information on the reported image, and using the specified enrichers."
      - name: report image by action
          # Specify cluster app-proxy
          CF_HOST: "${{ secrets.CF_RUNTIME_HOST }}"
          CF_API_KEY: ${{ secrets.USER_TOKEN }}
          # use image registry integration - the name of the integration used for pulling information on the image.

          # report image 
          CF_IMAGE: ${{ secrets.DOCKERHUB_USERNAME }}/build-by-github-action:0.0.1
          # integration with
          CF_ENRICHERS: "jira, git"
          # use githug token
          CF_GITHUB_TOKEN: ${{ secrets.CF_GITHUB_TOKEN }}    
          # use jira integration - jira is the name of the integration created in codefresh argo platform.
          CF_JIRA_INTEGRATION: "jira" 
          CF_JIRA_MESSAGE: "A message with embedded issue ( i.e. CR-11027 ) that would be use query jira for the ticket "
          # a specified prefix for finding the jira issue 
        uses: codefresh-io/codefresh-report-image@0.0.62

GitHub Action logs

View and analyze logs for GitHub Action workflows through the Logs tab. When a GitHub Action is run, it is added to the Logs tab.
You can:

  • Filter by status or by date range to view a subset of actions
  • Navigate to the build file in GitHub Actions, and view the Codefresh report image step

GitHub Action: Logs tab

GitHub Action: Logs tab

Build YAML in GitHub Action

The Run column includes the link to the build files for the actions.

Here are examples of the build file for the GitHub Action (top) and of the Codefresh report image step in the action (below).

Build file in GitHub Action

Build file in GitHub Action

Codefresh report image step in GitHub Action build file

Codefresh report image step in GitHub Action build file

Add Git sources to runtimes
Shared configuration repo