docs/appendices/0.29.0-migration-guide.md

# 0.29.0 Migration Guide

## Changes

- The output of `run:detached` now uses the container name - eg. `node-js-app.run.1` - vs the container id.
- The ID of `cron` tasks is now base36-encoded instead of base64-encoded.
- The `nginx.conf.sigil` is now extracted when source code is extracted for a build and not from the built image. Users can specify alternative paths via the `nginx-conf-sigil-path` property of the `nginx` plugin. See the [nginx documentation](/docs/networking/proxies/nginx.md#customizing-the-nginx-configuration) for more information on how to configure the `nginx.conf.sigil` path for your application.
    - For deploys via `git:from-image`, the `nginx.conf.sigil` file will be extracted from the source image, respecting the value of `nginx-conf-sigil-path`.
- The `Procfile` is now extracted when source code is extracted for a build and not from the built image. Users can specify alternative paths via the `procfile-path` property of the `ps` plugin. See the [process management documentation](/docs/processes/process-management.md#changing-the-procfile-location) for more information on how to configure the `Procfile` path for your application.
    - For deploys via `git:from-image`, the `Procfile` file will be extracted from the source image, respecting the value of `procfile-path`.
- The existing `pre-restore` hook has been renamed to `scheduler-pre-restore`. There is a new `pre-restore` hook that is triggered within the `ps:restore` command prior to restoring any apps.
- Nginx init commands are now performed via systemctl on Ubuntu systems when `/usr/bin/systemctl` is available.

## Removals

- The `DOKKU_WAIT_TO_RETIRE` environment variable has been migrated to a `checks` property named `wait-to-retire` and will be ignored if set as an environment variable.
- The `domains-setup` trigger has been removed. Initial app domains will now be automatically setup during app creation.
- The `URLS` file containing generated urls for an app is no longer generated or referenced. Users should retrieve app urls via the new `domains-urls` plugin trigger.
- The common function `get_app_urls` has been removed. Users should retrieve app urls via the new `domains-urls` plugin trigger.
feat: use container name instead of container id for run:detached output Closes #5170 2022-08-22 21:49:54 -04:00			`# 0.29.0 Migration Guide`

			`## Changes`

refactor: switch from base64-encoding to base36-encoding of cron task IDs This allows the IDs to be used as DNS labels, meaning they can be used as is for external scheduler task names. Closes #4903 2022-11-09 22:22:37 -05:00			- The output of `run:detached` now uses the container name - eg. `node-js-app.run.1` - vs the container id.
refactor: move DOKKU_WAIT_TO_RETIRE to a checks property This centralizes the property and removes one more dokku-specific property from the app environment variables. Closes #5049 2022-11-15 23:25:58 -05:00			- The ID of `cron` tasks is now base36-encoded instead of base64-encoded.
refactor: only extract the nginx.conf.sigil from the source code and not an app path The previous method was a bit more difficult for users to interact with as they needed to ensure the file was at a certain path in the built image. This change divorces the file from the built artifact, better aligning the nginx.conf.sigil handling with the rest of Dokku's monorepo support. A side effect of this is now building proxy configurations does not require access to the built image. Closes #5207 2022-11-23 19:30:45 -05:00			- The `nginx.conf.sigil` is now extracted when source code is extracted for a build and not from the built image. Users can specify alternative paths via the `nginx-conf-sigil-path` property of the `nginx` plugin. See the [nginx documentation](/docs/networking/proxies/nginx.md#customizing-the-nginx-configuration) for more information on how to configure the `nginx.conf.sigil` path for your application.
fix: keep track of the source image when building an app via git:from-image This change fixes issues with ps:rebuild not working as expected - essentially ignoring files in the repo - as well as adds tests. Closes #5518 2022-12-18 17:57:24 -05:00			- For deploys via `git:from-image`, the `nginx.conf.sigil` file will be extracted from the source image, respecting the value of `nginx-conf-sigil-path`.
			- The `Procfile` is now extracted when source code is extracted for a build and not from the built image. Users can specify alternative paths via the `procfile-path` property of the `ps` plugin. See the [process management documentation](/docs/processes/process-management.md#changing-the-procfile-location) for more information on how to configure the `Procfile` path for your application.
			- For deploys via `git:from-image`, the `Procfile` file will be extracted from the source image, respecting the value of `procfile-path`.
refactor: rename pre-restore trigger to scheduler-pre-restore This better reflects what the trigger does, and allows us to use the pre-restore trigger at the beginning of the ps:restore command. 2022-11-22 23:18:45 -05:00			- The existing `pre-restore` hook has been renamed to `scheduler-pre-restore`. There is a new `pre-restore` hook that is triggered within the `ps:restore` command prior to restoring any apps.
feat: switch to systemctl for interacting with the nginx init process 2022-11-28 01:52:27 -05:00			- Nginx init commands are now performed via systemctl on Ubuntu systems when `/usr/bin/systemctl` is available.
refactor: move DOKKU_WAIT_TO_RETIRE to a checks property This centralizes the property and removes one more dokku-specific property from the app environment variables. Closes #5049 2022-11-15 23:25:58 -05:00
			`## Removals`

refactor: cleanup zero'd out processes when a Procfile omitting those process types is set This change also moves the referenced Procfile out to a host path once on deploy vs potentially several times, which should speed up deploys a small amount and simplify reasoning about the file. Closes #5112 2022-11-25 00:41:55 -05:00			- The `DOKKU_WAIT_TO_RETIRE` environment variable has been migrated to a `checks` property named `wait-to-retire` and will be ignored if set as an environment variable.
refactor: setup app domains in the post-create hook This is more consistent with app setup, at the cost of making it so developers must disable domains manually afterwards. 2022-12-01 21:47:59 -05:00			- The `domains-setup` trigger has been removed. Initial app domains will now be automatically setup during app creation.
refactor: simplify how url generation works The URLS file is no longer necessary as urls are now generated directly from the app VHOST file. This also moves all the url generation logic to the domains plugin. 2022-12-02 02:19:59 -05:00			- The `URLS` file containing generated urls for an app is no longer generated or referenced. Users should retrieve app urls via the new `domains-urls` plugin trigger.
			- The common function `get_app_urls` has been removed. Users should retrieve app urls via the new `domains-urls` plugin trigger.