Skip to content

Commit 2110277

Browse files
committed
Add Taskfile with build command
Adjust README accordingly
1 parent 5d766f6 commit 2110277

3 files changed

Lines changed: 26 additions & 0 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
workspace

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,21 @@ A bunch of simple update scripts are run via [CustoPiZer](https://github.com/Oct
1414
* `80-install-user-fix`: Installs a compatibility layer to support renaming the `pi` user, if needed.
1515
* `99-write-build`: Writes the build tag to `/etc/octopiuptodate-build`
1616

17+
## How do I run this?
18+
19+
There's a [Taskfile](https://taskfile.dev) in this repository that you can use to run the update scripts locally.
20+
21+
- Install [Taskfile](https://taskfile.dev/installation/)
22+
- Install [Docker]()
23+
- Create a `workspace` directory and place your `input.img` in that
24+
- Run `task build`
25+
26+
Alternatively, you can also manually run `docker`:
27+
28+
```
29+
docker run --rm --privileged -v $(pwd)/workspace:/CustoPiZer/workspace $(pwd)/scripts:/CustoPiZer/workspace/scripts ghcr.io/octoprint/custopizer:latest
30+
```
31+
1732
## Can I do something like this as well?
1833

1934
Sure, check out [CustoPiZer's README](https://github.com/OctoPrint/CustoPiZer) for

Taskfile.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: "3"
2+
3+
tasks:
4+
build:
5+
cmds:
6+
- |
7+
{{if eq OS "windows"}}powershell {{end}}docker run --rm --privileged -v {{.USER_WORKING_DIR | toSlash}}/workspace:/CustoPiZer/workspace -v {{.USER_WORKING_DIR | toSlash}}/scripts:/CustoPiZer/workspace/scripts ghcr.io/octoprint/custopizer:latest
8+
preconditions:
9+
- test -d workspace
10+
- test -f workspace/input.img

0 commit comments

Comments
 (0)