From fe9a89024350671e351e2ab0cf615620155fec26 Mon Sep 17 00:00:00 2001 From: Flavio Poletti Date: Mon, 8 Jul 2024 08:12:17 +0200 Subject: [PATCH] Propose doc changes for procfile-path property --- docs/processes/process-management.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/processes/process-management.md b/docs/processes/process-management.md index 839081734..747cb5b84 100644 --- a/docs/processes/process-management.md +++ b/docs/processes/process-management.md @@ -153,15 +153,20 @@ The `Procfile` also supports a special `release` command which acts in a similar #### Changing the `Procfile` location -When deploying a monorepo, it may be desirable to specify the specific path of the `Procfile` file to use for a given app. This can be done via the `ps:set` command. If a value is specified and that file does not exist within the repository, Dokku will continue the build process as if the repository has no `Procfile`. +The `Procfile` is expected to be found in a specific directory, depending on the deploy approach: -For deploys via the `git:from-image` and `git:load-image` commands, the `Procfile` is extracted from the configured `WORKDIR` property of the image. For all other deploys - git push, `git:from-archive`, `git:sync` - will have the `Procfile` extracted directly from the source code. Both cases will respect the configured `procfile-path` property value. +- The `WORKDIR` of the Docker image for deploys resulting from `git:from-image` and `git:load-image` commands. +- The root of the source code tree for all other deploys (git push, `git:from-archive`, `git:sync`). + +Sometimes it may be desirable to set a different path for a given app, e.g. when deploying from a monorepo. This can be done via the `procfile-path` property: ```shell dokku ps:set node-js-app procfile-path .dokku/Procfile ``` -The default value may be set by passing an empty value for the option: +The value is the path to the desired file *relative* to the base search directory (absolute paths don't work by design). If that file does not exist within the repository, Dokku will continue the build process as if the repository has no `Procfile`. + +If a value is set, the default value may be set back by passing an empty value for the property: ```shell dokku ps:set node-js-app procfile-path