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: README.md
+10-4Lines changed: 10 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,13 @@
1
-
# Codefresh pipeline runner
1
+
# Codefresh pipeline runner GitHub Action
2
2
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
+
Codefresh is a CI/CD platform that engineers actually love to use. The [Codefresh pipeline](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/pipelines/) runner GitHub action will trigger an existing Codefresh pipeline from a GitHub action.
4
+
5
+
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.
4
6
5
7
# Integrating Codefresh pipelines with GitHub actions
6
8
7
9
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
10
+
when a specific GitHub event happens. GitHub actions can also use Codefresh pipelines as a back-end
9
11
resulting in a very powerful combination where the first action starts from GitHub, but Codefresh takes care
10
12
of the actual compilation or deployment in a pipeline.
11
13
@@ -32,6 +34,7 @@ In order to use the GitHub action, fork this repository and then navigate to the
32
34
33
35
Select the pipeline runner action and click the "Edit" button. On the right side panel enter the following
34
36
37
+
### Inputs
35
38
* A secret with name `CF_API_KEY` and value your Codefresh API token
36
39
* An environment variable called `PIPELINE_NAME` with a value of `<project_name>/<pipeline_name>`
37
40
* An optional environment variable called `TRIGGER_NAME` with trigger name attached to this pipeline. See the [triggers section](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/triggers/) for more information
@@ -40,9 +43,12 @@ Click the Done button to save your changes and commit.
40
43
41
44
Now next time you commit anything in your GitHub repository the Codefresh pipeline will also execute.
42
45
46
+
### Outputs
47
+
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.
48
+
43
49
## Usage
44
50
45
-
An example to run codefresh pipeline that can compile, test, docker build and deploy to kubernetes
51
+
Running a Codefresh pipeline to compile, test, docker build, and deploy to kubernetes
46
52
```
47
53
name: 'Codefresh pipeline runner'
48
54
description: 'GitHub action that run codefresh pipeline'
0 commit comments