Skip to content

Commit 76da192

Browse files
committed
📝 Document config action parameter
1 parent 6f5dfb8 commit 76da192

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ EDITBASE_IMAGE_ENLARGEROOT=100
4545
EDITBASE_IMAGE_RESIZEROOT=20
4646
```
4747

48+
This can be achieved through `-v /path/to/config.local:/CustoPiZer/config.local` in the docker command, e.g.
49+
50+
```
51+
docker run --rm --privileged -v /path/to/workspace:/CustoPiZer/workspace -v /path/to/config.local:/CustoPiZer/config.local ghcr.io/octoprint/custopizer:latest
52+
```
53+
4854
### Example
4955

5056
Place this in `workspace/scripts/01-update-octoprint`:
@@ -116,6 +122,18 @@ inside the script context, e.g.:
116122
>
117123
> environment: "{ 'OCTOPRINT_VERSION': '${{ env.OCTOPRINT_VERSION }}' }"
118124

125+
If you need to provide a custom `config.local`, e.g. to override filesystem extending/shrinking,
126+
you can do that via the `config` parameter:
127+
128+
``` yaml
129+
- name: Run CustoPiZer
130+
uses: OctoPrint/CustoPiZer@main
131+
with:
132+
workspace: "${{ github.workspace }}/build"
133+
scripts: "${{ github.workspace }}/scripts"
134+
config: "${{ github.workspace }}/config.local"
135+
```
136+
119137
For a complex example usage that also includes repository dispatch, creating releases and attaching assets, take a look at the scripts and workflow of [OctoPrint/OctoPi-UpToDate](https://github.com/OctoPrint/OctoPi-UpToDate).
120138

121139
## Writing customization scripts

0 commit comments

Comments
 (0)