Skip to content

Commit 321a915

Browse files
committed
fix python docs formatting
1 parent 4e94631 commit 321a915

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

nodejs-setup-project.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ The workflow [file](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloW
33
1. `workflow_dispatch:` gives you the option to manually run your workflow from the Actions section of your project
44

55
2. On pushes to main, it will kick off the workflow but ignore the push if it's only changes made to the workflow file.
6+
67
```yml
78
push:
89
branches: [ main ]

py-setup-project.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
### 1. Add GitHub workflow
22
The workflow [file](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/blob/main/.github/workflows/Publish%20Release.yml) will help build and deploy your project, it does the following things:
33
1. `workflow_dispatch:` gives you the option to manually run your workflow from the Actions section of your project
4+
45
2. On pushes to main, it will kick off the workflow but ignore the push if it's only changes made to the workflow file.
6+
57
```yml
68
push:
79
branches: [ main ]
810
paths-ignore:
911
- .github/workflows/*
1012
```
13+
1114
3. It specifies the python version that will be used for building your project:
15+
1216
```yml
1317
env:
1418
python_ver: 3.8
1519
```
20+
1621
4. The project's release version is obtained from your plugin.json automatically by the ci, so when built it will be appended to the zip file later:
22+
1723
```yml
1824
- name: get version
1925
id: version
@@ -22,9 +28,11 @@ push:
2228
path: 'plugin.json'
2329
prop_path: 'Version'
2430
```
31+
2532
5. The 'Install dependencies' section is where you will do most of your CI work. Notice it installs the requirements.txt and outputs it with the `-t` parameter to the `./lib` folder. This tells pip to dump all the installed modules to the local lib folder which you will zip up along with your project using the `zip -r Flow.Launcher.Plugin.HelloWorldPython.zip . -x '*.git*'`, where you replace this `Flow.Launcher.Plugin.HelloWorldPython` with the name of your plugin.
2633

2734
You can also add additional steps here to unpack/install any additional depedencies your plugin requires, for example compiling additional translation files like [this](https://github.com/deefrawley/Flow.Launcher.Plugin.Currency/blob/23770ee929af059b1b1b7f9b5f3327b692ac9587/.github/workflows/Publish%20Release.yml#L34)
35+
2836
```yml
2937
- name: Install dependencies
3038
run: |

0 commit comments

Comments
 (0)