@ -21,31 +21,36 @@ that everyone should follow.
## Docker Development
The project's `Dockerfile` builds in two different mods: Development and production mode.
The project's `Dockerfile` build requires the Recyclarr build output to be placed in a specific
location in order to succeed. The location is below, relative to the clone root:
### Production Build
```txt
docker/artifacts/recyclarr-${{runtime}}
```
This is the default build type for the image. Given a specific version number, it will grab the
appropriate binary from the corresponding Github Release and install that into the image .
Where `${{runtime}}` is one of the runtimes compatible with `dotnet publish` , such as
`linux-musl-x64`
### Development Build
There is a convenience script named `docker/Build-Artifacts.ps1` that will perform a build and place
the output in the appropriate location for you. This simplifies the process of testing docker
locally to these steps:
This build allows you to make changes to Recyclarr and pull those into a local docker image build.
This is especially useful if you want to test changes in Recyclarr before it is released, since the
production mode of Recyclarr requires a Github release to pull from.
1. Run the convenience script to build and publish Recyclarr to the Docker artifacts directory:
To enable development builds, specify the build argument `BUILD_FROM_BRANCH` . The workflow I use
goes something like this:
```sh
pwsh ci/Build-Artifacts.ps1
```
> *Note:* The runtime defaults to `linux-musl-x64` but you can pass in an override as the first
> placeholder argument to the above command.
1. Create a branch to work out of: `git checkout -b docker origin/master` .
1. Make some C# code changes, commit, and **push to the remote repo** .
1. Build the docker image locally:
1. Execute a Docker build locally via compose:
```sh
docker compose build --no-cache --progress plain --build-arg BUILD_FROM_BRANCH=docker
docker compose build --no-cache --progress plain
```
1. Execute it locally :
1. Run the container to test it :
```sh
docker compose run --rm recyclarr sonarr
@ -53,24 +58,11 @@ goes something like this:
### Build Arguments
- `RELEASE_TAG` (Default: `latest` )< br >
The git tag (e.g. `v2.1.2` ) that represents the Github Release in the upstream repository to grab
binaries from. May also use `latest` to represent the latest Github Release. Only used in
Production builds.
- `TARGETPLATFORM` (Default: empty)< br >
Required. Specifies the runtime architecture of the image and is used to pull the correct prebuilt
binary from the specified Github Release. See the table in the Platform Support section for a list
of valid values.
- `REPOSITORY` (Default: `recyclarr/recyclarr` )< br >
The Github repository name (either `user/repo` or `organization/repo` format) used to grab the
prebuilt release from (in Production builds) or to clone (in Development builds).
- `BUILD_FROM_BRANCH` (Default: empty)< br >
If specified, Development build mode is enabled and the branch name specified here is used to
compile Recyclarr and use its final binary in the resulting docker image.
### Platform Support
| Docker Platform | Recyclarr Runtime |
Robert Dailey
3 years ago