Skip to content

Commit 2005888

Browse files
refactor
1 parent ef18039 commit 2005888

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
# Codefresh pipeline runner
22

3-
This repository holds a Github action that can be used to call existing [Codefresh pipelines](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/pipelines/). It is based on the [Codefresh CLI](https://codefresh-io.github.io/cli/) which can execute Codefresh pipelines remotely (using an API key for authentication). The Codefresh CLI is already available as a [public Docker image](https://hub.docker.com/r/codefresh/cli/), so creating a Github action with it is a trivial process.
3+
This repository holds a GitHub action that can be used to call existing [Codefresh pipelines](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/pipelines/). It is based on the [Codefresh CLI](https://codefresh-io.github.io/cli/) which can execute Codefresh pipelines remotely (using an API key for authentication). The Codefresh CLI is already available as a [public Docker image](https://hub.docker.com/r/codefresh/cli/), so creating a GitHub action with it is a trivial process.
44

55
# Integrating Codefresh pipelines with GitHub actions
66

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

1212
## Prerequisites
1313

1414
Make sure that you have
1515

16-
* a Github account with Actions enabled
16+
* a GitHub account with Actions enabled
1717
* a [Codefresh account](https://codefresh.io/docs/docs/getting-started/create-a-codefresh-account/) with one or more existing pipelines ready
18-
* a [Codefresh API token](https://codefresh.io/docs/docs/integrations/codefresh-api/#authentication-instructions) that will be used as a secret in the Github action
18+
* a [Codefresh API token](https://codefresh.io/docs/docs/integrations/codefresh-api/#authentication-instructions) that will be used as a secret in the GitHub action
1919

2020

2121
## How the Codefresh action works
2222

23-
The Github workflow is placed on the [push event](https://developer.github.com/v3/activity/events/types/#pushevent) and therefore starts whenever a Git commit happens. The Workflow has a single action that starts the Codefresh pipeline runner.
23+
The GitHub workflow is placed on the [push event](https://developer.github.com/v3/activity/events/types/#pushevent) and therefore starts whenever a Git commit happens. The Workflow has a single action that starts the Codefresh pipeline runner.
2424

2525
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.
2626

2727
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
2828

29-
## How to use the Codefresh Github action
29+
## How to use the Codefresh GitHub action
3030

31-
In order to use the Github action, fork this repository and then navigate to the "Actions" tab in Github. Click on the "View main.workflow" button on the right hand side. Make sure that an actual branch is selected on the top left of the window. Then click the "Edit this file" button in the main workarea (exactly as you would edit a normal git file via Github)
31+
In order to use the GitHub action, fork this repository and then navigate to the "Actions" tab in GitHub. Click on the "View main.workflow" button on the right hand side. Make sure that an actual branch is selected on the top left of the window. Then click the "Edit this file" button in the main workarea (exactly as you would edit a normal git file via GitHub)
3232

3333
Select the pipeline runner action and click the "Edit" button. On the right side panel enter the following
3434

@@ -38,14 +38,14 @@ Select the pipeline runner action and click the "Edit" button. On the right side
3838

3939
Click the Done button to save your changes and commit.
4040

41-
Now next time you commit anything in your Github repository the Codefresh pipeline will also execute.
41+
Now next time you commit anything in your GitHub repository the Codefresh pipeline will also execute.
4242

4343
## Usage
4444

4545
An example to run codefresh pipeline that can compile, test , docker build and deploy to kubernetes
4646
```
4747
name: 'Codefresh pipeline runner'
48-
description: 'Github action that run codefresh pipeline'
48+
description: 'GitHub action that run codefresh pipeline'
4949
author: 'codefresh'
5050
branding:
5151
icon: 'arrow-right-circle'

0 commit comments

Comments
 (0)