|
| 1 | +#!/usr/bin/env bash |
| 2 | + |
| 3 | +function checks::ensure_supported_stack() { |
| 4 | + local stack="${1}" |
| 5 | + |
| 6 | + case "${stack}" in |
| 7 | + heroku-20 | heroku-22 | heroku-24) |
| 8 | + return 0 |
| 9 | + ;; |
| 10 | + cedar* | heroku-16 | heroku-18) |
| 11 | + # This error will only ever be seen on non-Heroku environments, since the |
| 12 | + # Heroku build system rejects builds using EOL stacks. |
| 13 | + output::error <<-EOF |
| 14 | + Error: The '${stack}' stack is no longer supported. |
| 15 | +
|
| 16 | + This buildpack no longer supports the '${stack}' stack since it has |
| 17 | + reached its end-of-life: |
| 18 | + https://devcenter.heroku.com/articles/stack#stack-support-details-for-apps-using-classic-buildpacks |
| 19 | +
|
| 20 | + Upgrade to a newer stack to continue using this buildpack. |
| 21 | + EOF |
| 22 | + meta_set "failure_reason" "stack::eol" |
| 23 | + exit 1 |
| 24 | + ;; |
| 25 | + *) |
| 26 | + output::error <<-EOF |
| 27 | + Error: The '${stack}' stack is not recognised. |
| 28 | +
|
| 29 | + This buildpack does not recognise or support the '${stack}' stack. |
| 30 | +
|
| 31 | + If '${stack}' is a valid stack, make sure that you are using the latest |
| 32 | + version of this buildpack and have not pinned to an older release: |
| 33 | + https://devcenter.heroku.com/articles/managing-buildpacks#view-your-buildpacks |
| 34 | + https://devcenter.heroku.com/articles/managing-buildpacks#classic-buildpacks-references |
| 35 | + EOF |
| 36 | + meta_set "failure_reason" "stack::unknown" |
| 37 | + exit 1 |
| 38 | + ;; |
| 39 | + esac |
| 40 | +} |
| 41 | + |
| 42 | +# TODO: Turn this into an error in January 2025. |
| 43 | +function checks::warn_if_duplicate_python_buildpack() { |
| 44 | + local build_dir="${1}" |
| 45 | + |
| 46 | + # The check for the `PYTHONHOME` env var prevents this warning triggering in the case |
| 47 | + # where the Python install was committed to the Git repo (which will be handled later). |
| 48 | + # (The env var can only have come from the `export` file of an earlier buildpack, |
| 49 | + # since app provided config vars haven't been exported to the environment here.) |
| 50 | + if [[ -f "${build_dir}/.heroku/python/bin/python" && -v PYTHONHOME ]]; then |
| 51 | + output::warning <<-EOF |
| 52 | + Warning: The Python buildpack has already been run this build. |
| 53 | +
|
| 54 | + An existing Python installation was found in the build directory |
| 55 | + from a buildpack run earlier in the build. |
| 56 | +
|
| 57 | + This normally means there are duplicate Python buildpacks set |
| 58 | + on your app, which is not supported, can cause errors and |
| 59 | + slow down builds. |
| 60 | +
|
| 61 | + Check the buildpacks set on your app and remove any duplicate |
| 62 | + Python buildpack entries: |
| 63 | + https://devcenter.heroku.com/articles/managing-buildpacks#view-your-buildpacks |
| 64 | + https://devcenter.heroku.com/articles/managing-buildpacks#remove-classic-buildpacks |
| 65 | +
|
| 66 | + If you have a use-case that requires duplicate buildpacks, |
| 67 | + please comment on: |
| 68 | + https://github.com/heroku/heroku-buildpack-python/issues/1704 |
| 69 | +
|
| 70 | + In January 2025 this warning will be made an error. |
| 71 | + EOF |
| 72 | + meta_set "duplicate_python_buildpack" "true" |
| 73 | + # shellcheck disable=SC2034 # This is used below until we make this check an error. |
| 74 | + DUPLICATE_PYTHON_BUILDPACK=1 |
| 75 | + fi |
| 76 | +} |
| 77 | + |
| 78 | +# TODO: Turn this into an error in January 2025. |
| 79 | +function checks::warn_if_existing_python_dir_present() { |
| 80 | + local build_dir="${1}" |
| 81 | + |
| 82 | + # Avoid warning twice in the case of duplicate buildpacks. |
| 83 | + # TODO: Remove this once `warn_if_duplicate_python_buildpack` becomes an error. |
| 84 | + if [[ -v DUPLICATE_PYTHON_BUILDPACK ]]; then |
| 85 | + return 0 |
| 86 | + fi |
| 87 | + |
| 88 | + # We use `-e` here to catch the case where `python` is a file rather than a directory. |
| 89 | + if [[ -e "${build_dir}/.heroku/python" ]]; then |
| 90 | + output::warning <<-EOF |
| 91 | + Warning: Existing '.heroku/python/' directory found. |
| 92 | +
|
| 93 | + Your app's source code contains an existing directory named |
| 94 | + '.heroku/python/', which is where the Python buildpack needs |
| 95 | + to install its files. This existing directory contains: |
| 96 | +
|
| 97 | + $(find .heroku/python/ -maxdepth 2 || true) |
| 98 | +
|
| 99 | + Writing to internal locations used by the Python buildpack |
| 100 | + is not supported and can cause unexpected errors. |
| 101 | +
|
| 102 | + If you have committed a '.heroku/python/' directory to your |
| 103 | + Git repo, you must delete it or use a different location. |
| 104 | +
|
| 105 | + Otherwise, check that an earlier buildpack or 'bin/pre_compile' |
| 106 | + hook has not created this directory. |
| 107 | +
|
| 108 | + If you have a use-case that requires writing to this location, |
| 109 | + please comment on: |
| 110 | + https://github.com/heroku/heroku-buildpack-python/issues/1704 |
| 111 | +
|
| 112 | + In January 2025 this warning will be made an error. |
| 113 | + EOF |
| 114 | + meta_set "existing_python_dir" "true" |
| 115 | + fi |
| 116 | +} |
0 commit comments