Skip to content

Commit fb7a415

Browse files
Update README.md
1 parent 454e178 commit fb7a415

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,6 @@ 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-
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)
34-
35-
Select the pipeline runner action and click the "Edit" button. On the right side panel enter the following
36-
37-
### Inputs
38-
* A secret with name `CF_API_KEY` and value your Codefresh API token ( https://codefresh.io/docs/docs/integrations/codefresh-api/#authentication-instructions )
39-
* An environment variable called `PIPELINE_NAME` with a value of `<project_name>/<pipeline_name>`
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
41-
42-
Click the Done button to save your changes and commit.
43-
44-
Now next time you commit anything in your GitHub repository the Codefresh pipeline will also execute.
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-
49-
## Usage
50-
5133
Running a Codefresh pipeline to compile, test, docker build, and deploy to kubernetes
5234
```
5335
name: 'Codefresh pipeline runner'
@@ -92,3 +74,15 @@ jobs:
9274
CF_API_KEY: ${{ secrets.GITHUB_TOKEN }}
9375
id: run-pipeline
9476
```
77+
### Inputs
78+
* A secret with name `CF_API_KEY` and value your Codefresh API token ( https://codefresh.io/docs/docs/integrations/codefresh-api/#authentication-instructions )
79+
* An environment variable called `PIPELINE_NAME` with a value of `<project_name>/<pipeline_name>`
80+
* 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
81+
82+
Click the Done button to save your changes and commit.
83+
84+
Now next time you commit anything in your GitHub repository the Codefresh pipeline will also execute.
85+
86+
### Outputs
87+
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.
88+

0 commit comments

Comments
 (0)