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
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)).
4
4
5
5
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).
6
6
7
7
# Example
8
8
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.
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)
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.
31
22
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
+
32
25
## Inputs
33
26
34
27
* python_version:
@@ -49,6 +42,19 @@ In order for the Action to have access to the code, you must use the actions/che
49
42
* should_run:
50
43
* description: runs `kedro run`
51
44
* 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
52
58
53
59
## Example Workflow
54
60
@@ -62,23 +68,11 @@ on:
62
68
63
69
jobs:
64
70
kedro:
65
-
66
71
runs-on: ubuntu-latest
67
-
68
72
steps:
69
73
- uses: actions/checkout@master
70
74
- 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
78
76
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
0 commit comments