Skip to content

Commit

Permalink
📝 Document config action parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
foosel committed Oct 12, 2021
1 parent 6f5dfb8 commit 76da192
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ EDITBASE_IMAGE_ENLARGEROOT=100
EDITBASE_IMAGE_RESIZEROOT=20
```

This can be achieved through `-v /path/to/config.local:/CustoPiZer/config.local` in the docker command, e.g.

```
docker run --rm --privileged -v /path/to/workspace:/CustoPiZer/workspace -v /path/to/config.local:/CustoPiZer/config.local ghcr.io/octoprint/custopizer:latest
```

### Example

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

If you need to provide a custom `config.local`, e.g. to override filesystem extending/shrinking,
you can do that via the `config` parameter:

``` yaml
- name: Run CustoPiZer
uses: OctoPrint/CustoPiZer@main
with:
workspace: "${{ github.workspace }}/build"
scripts: "${{ github.workspace }}/scripts"
config: "${{ github.workspace }}/config.local"
```

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).

## Writing customization scripts
Expand Down

0 comments on commit 76da192

Please sign in to comment.