Skip to content

Commit 63d00b7

Browse files
committed
Update readme
1 parent 3784194 commit 63d00b7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

+26
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,32 @@ Well, here's an action for you then! 🦸‍♀️
1414
### Usage from Github Actions
1515

1616
The recommended way to use this tool is as a Github Action.
17+
It needs to be run on a windows runner and IronPython/NuGet need to be pre-installed.
18+
19+
Copy the following workflow code into a `.github/workflows/main.yml` file in your repository.
20+
Make sure you have the components definition (see below for details) stored in a source folder.
21+
Replace the `source` and `target` to match your folder structure.
22+
23+
```yaml
24+
on: [push]
25+
26+
jobs:
27+
build_ghuser_components:
28+
runs-on: windows-latest
29+
name: Build components
30+
steps:
31+
- uses: actions/checkout@v2
32+
- uses: NuGet/[email protected]
33+
- name: Install IronPython
34+
run: |
35+
choco install ironpython --version=2.7.8.1
36+
- uses: compas-dev/compas-actions.ghpython_components@main
37+
with:
38+
source: components
39+
target: build
40+
```
41+
42+
Commit, push and enjoy! 🍿
1743
1844
### Usage on the command line
1945

0 commit comments

Comments
 (0)