Skip to content

Commit 75ab207

Browse files
authored
Update README.md
1 parent 2babdf8 commit 75ab207

File tree

1 file changed

+23
-29
lines changed

1 file changed

+23
-29
lines changed

README.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,27 @@
1-
# Kedro-Action
1+
# ![Kedro-Action](artwork/Kedro-Action.png)
22

3-
A GitHub Action to `lint`, `test`, `build-docs`, `package`, and `run` your [kedro](https://github.com/quantumblacklabs/kedro) pipelines. Supports any Python version you'll give it (that is also supported by [pyenv](https://github.com/pyenv/pyenv)).
3+
A GitHub Action to `lint`, `test`, `build-docs`, `package`, `static-viz`, and `run` your [kedro](https://github.com/quantumblacklabs/kedro) pipelines. Supports any Python version you'll give it (that is also supported by [pyenv](https://github.com/pyenv/pyenv)).
44

55
Inspired by [mariamrf/py-package-publish-action](https://github.com/mariamrf/py-package-publish-action) and [crazy-max/ghaction-github-pages](https://github.com/crazy-max/ghaction-github-pages).
66

77
# Example
88

9-
check out [WaylonWalker/default-kedro157](https://github.com/WaylonWalker/default-kedro157/) for a working example of the action.
9+
Check out [WaylonWalker/default-kedro157](https://github.com/WaylonWalker/default-kedro157/) for a working example of the action.
1010

11-
# Releases
11+
[![Static Viz](artwork/kedro-static-viz.png)](https://default-kedro-157.waylonwalker.com/)
1212

13-
## Version 1.0.3
14-
15-
Version 1 has been released. It is very simple and just runs all of the kedro cli commands to install, test, lint, build-docs, package, and run your project. If you want to keep any of the information you will need to create an artifact manually, or for docs push them to a gh-pages directory
16-
17-
## Version 2 (develop branch)
18-
19-
* suppress command output
20-
* run same kedro commands
21-
* create static pipeline visualization
22-
* create html testing report
23-
* automatically deploy web artifacts to kedro-action branch (viz, test_report, docs)
13+
[![Docs](artwork/docs.png)](https://default-kedro-157-docs.netlify.com/)
2414

15+
[![Test report](artwork/test-report.png)](https://default-kedro-157-test.netlify.com/)
2516

2617
# Use
2718

2819
## Pre-requisits
2920

3021
In order for the Action to have access to the code, you must use the actions/checkout@master job before it. See the example below.
3122

23+
For kedro-action to commit results back to the `kedro-action` branch you must supply a GitHub Personal Access Token through the secrets manager. See [this link](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) for more help.
24+
3225
## Inputs
3326

3427
* python_version:
@@ -49,6 +42,19 @@ In order for the Action to have access to the code, you must use the actions/che
4942
* should_run:
5043
* description: runs `kedro run`
5144
* default: false
45+
* should_viz:
46+
* description: creates a static site built on gatsby based on `kedro viz --save-pipeline pipeline.json`
47+
* default: true
48+
* deploy_branch
49+
* branch to deploy static site to
50+
* default: kedro-action
51+
* github_pat
52+
* description: github personal access token
53+
* for help: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
54+
* default: null
55+
* verbose
56+
* description: prints extra information for debugging
57+
* default: false
5258

5359
## Example Workflow
5460

@@ -62,23 +68,11 @@ on:
6268

6369
jobs:
6470
kedro:
65-
6671
runs-on: ubuntu-latest
67-
6872
steps:
6973
- uses: actions/checkout@master
7074
- name: Kedro
71-
uses: WaylonWalker/kedro-action@1.0.3
72-
with:
73-
python_version: '3.7.0'
74-
# OPTIONAL
75-
# Deploy docs to gh-pages branch
76-
- name: Deploy-docs
77-
uses: crazy-max/ghaction-github-pages@v1.3.0
75+
uses: WaylonWalker/kedro-action@2.0.0
7876
with:
79-
target_branch: gh-pages-docs
80-
build_dir: docs/build/html
81-
env:
82-
GITHUB_PAT: ${{ secrets.GITHUB_PAT }}
77+
GITHUB_PAT: ${{ secrets.GITHUB_PAT }} # required for push to kedro-action branch
8378

84-
```

0 commit comments

Comments
 (0)