Skip to content

Commit 71407f9

Browse files
committed
add publishing instructions
1 parent 46824a6 commit 71407f9

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
11
# Arithmetic Example Workflow
22
[![Pipeline](https://github.com/pythonworkflow/example-workflow/actions/workflows/pipeline.yml/badge.svg)](https://github.com/pythonworkflow/example-workflow/actions/workflows/pipeline.yml)
33

4-
Demonstration for publishing an interoperable workflow based on the Python Workflow Definition. The minimal workflow consists of three files:
4+
Template repository for publishing an interoperable workflow based on the Python Workflow Definition.
55

6-
| File | Explanation |
7-
|-----------------|---------------------------------------------------------|
8-
| environment.yml | Conda environment for software dependencies |
9-
| workflow.py | Python functions representing the nodes of the workflow |
10-
| workflow.json | Workflow graph consisting of nodes and edges |
6+
## Content
7+
The minimal workflow consists of three files:
8+
9+
| File | Explanation |
10+
|-------------------|---------------------------------------------------------|
11+
| `environment.yml` | Conda environment for software dependencies |
12+
| `workflow.py` | Python functions representing the nodes of the workflow |
13+
| `workflow.json` | Workflow graph consisting of nodes and edges |
1114

1215
Additional optional files for the publication of the workflow:
1316

14-
| File | Explanation |
15-
|--------------------------------|------------------------------------------|
16-
| README.md | Readme file to introduce the workflow |
17-
| .github/workflows/pipeline.yml | Github Actions to test the workflow |
17+
| File | Explanation |
18+
|----------------------------------|------------------------------------------|
19+
| `README.md` | Readme file to introduce the workflow |
20+
| `.github/workflows/pipeline.yml` | Github Actions to test the workflow |
21+
22+
## Publish your workflow
23+
You can publish your workflow in five simple steps:
24+
* Fork the repository and clone your fork locally.
25+
* Export your workflow to the Python Workflow Definition using the `python_workflow_definition` Python package, by calling the `write_workflow_json()` function.
26+
* Replace the `environment.yml`, `workflow.py` and `workflow.json` in your local folder with the files for your workflow. In addition, you can add additional files if they are required and update the `README.md` to explain your workflow.
27+
* Commit the files locally using `git add -A` and `git commit -m "add my workflow"`
28+
* Push your workflow to Github `git push`
29+
30+

0 commit comments

Comments
 (0)