docker-d2-builder/README.md
2024-11-13 20:00:28 +00:00

32 lines
1.1 KiB
Markdown

<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-d2-builder/blob/main/.github/CONTRIBUTING.md -->
# linuxserver/d2-builder
Expects to run as part of the LSIO CI process. Not for public consumption.
## Running against image
If you need to test functionality just run:
```bash
docker pull lscr.io/linuxserver/d2-builder:latest && \
docker run -d --rm -v /tmp/d2:/output -e PUID=1000 -e PGID=1000 lscr.io/linuxserver/d2-builder:latest mastodon:latest
```
## Running against local project
If you need to test functionality, make sure you have the necessary repos cloned locally and the correct branches checked out then just run:
```bash
docker pull lscr.io/linuxserver/d2-builder:latest && \
docker run -d --rm -v /tmp/d2:/output -v /opt/repos:/input:ro -e PUID=1000 -e PGID=1000 -e LOCAL=true lscr.io/linuxserver/d2-builder:latest mastodon:latest
```
Generated d2 and svg files will be created in `/output`. If `RAW=true` then only d2 files will be created.
## Versions
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }