Skip to content

Commit fc39d8c

Browse files
Merge remote-tracking branch 'origin/master'
2 parents 41a0265 + 2ea9ac3 commit fc39d8c

File tree

1 file changed

+14
-41
lines changed

1 file changed

+14
-41
lines changed

README.md

Lines changed: 14 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -30,54 +30,27 @@ The result is that all the details from the Git push (i.e. the GIT hash) are tra
3030

3131
## How to use the Codefresh GitHub action
3232

33-
Running a Codefresh pipeline to compile, test, docker build, and deploy to kubernetes
34-
```
35-
name: 'Codefresh pipeline runner'
36-
description: 'GitHub action that run codefresh pipeline'
37-
author: 'codefresh'
38-
branding:
39-
icon: 'arrow-right-circle'
40-
color: 'green'
41-
runs:
42-
using: 'docker'
43-
image: 'Dockerfile'
44-
inputs:
45-
PIPELINE_NAME:
46-
description: 'Codefresh pipeline name in format <project_name>/<pipeline_name>'
47-
required: true
48-
TRIGGER_NAME:
49-
description: 'Trigger name attached to this pipeline'
50-
required: false
51-
CF_API_KEY
52-
description: 'Codefresh api token'
53-
required: true
54-
outputs:
55-
status:
56-
description: 'Pipeline status that was executed on codefresh'
57-
58-
```
59-
6033
An example of workflow
6134

6235
```
63-
version: 1.0
64-
on:
65-
push:
66-
branches:
67-
- master
68-
36+
name: run codefresh pipeline
37+
on: push
6938
jobs:
7039
build:
40+
runs-on: ubuntu-18.04
7141
steps:
72-
- name: 'run pipeline'
73-
uses: ./
74-
with:
75-
PIPELINE_NAME: 'codefresh-pipeline'
76-
TRIGGER_NAME: 'codefresh-trigger'
77-
CF_API_KEY: ${{ secrets.GITHUB_TOKEN }}
78-
id: run-pipeline
42+
- name: Checkout
43+
uses: actions/checkout@master
44+
45+
- name: 'run pipeline'
46+
uses: actions/codefresh-pipeline-runner@v1
47+
env:
48+
PIPELINE_NAME: 'codefresh-pipeline'
49+
TRIGGER_NAME: 'codefresh-trigger'
50+
CF_API_KEY: ${{ secrets.GITHUB_TOKEN }}
51+
id: run-pipeline
7952
```
80-
### Inputs
53+
### Env variables
8154
* A secret with name `CF_API_KEY` and value your Codefresh API token ( https://codefresh.io/docs/docs/integrations/codefresh-api/#authentication-instructions )
8255
* An environment variable called `PIPELINE_NAME` with a value of `<project_name>/<pipeline_name>`
8356
* 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

0 commit comments

Comments
 (0)