diff --git a/Dockerfile b/Dockerfile index a283b11..5a0d91a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -54,5 +54,5 @@ RUN uv sync --locked --no-dev # apt-get update; \ # apt-get -y install docker-engine -ENTRYPOINT ["uv", "run", "buildrunner"] +ENTRYPOINT ["uv", "--project", "/app", "run", "--no-sync", "buildrunner"] CMD [] diff --git a/docs/installation.rst b/docs/installation.rst index b9d23db..33a83cb 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -27,7 +27,8 @@ To install Buildrunner, run the following command: The buildrunner executable is now available in your path. -Alternatively, you can use the ``uvx`` command to run buildrunner: +Alternatively, you can use the ``uvx`` command to run buildrunner directly which will automatically download and +install buildrunner into an isolated environment, which is then cached for subsequent runs: .. code:: bash @@ -51,6 +52,11 @@ The buildrunner executable is now available via ``uv run buildrunner``. Docker Container ################ +.. warning:: + This method of running buildrunner is now deprecated in favor of using Astral UV + as described above. The scripts may be removed in a future release and a warning has been + added to all script runs. + Buildrunner can be run as a Docker container. This works cross-platform and is the easiest way to keep up to date. @@ -64,8 +70,7 @@ is the easiest way to keep up to date. You can now use the ``buildrunner`` command to run buildrunner in a Docker container. -.. note:: WINDOWS USERS: This is the recommended method for Windows users, however, you must make - sure that you are using the `BASH shell +.. note:: WINDOWS USERS: Make sure that you are using the `BASH shell `_ enhancements for Windows or that you have something installed that enables the use of ``sh``, or else this method will not work. If you are using WSL and the hyper-v installation of docker: diff --git a/scripts/buildrunner b/scripts/buildrunner index e90aaaa..537cd40 100755 --- a/scripts/buildrunner +++ b/scripts/buildrunner @@ -20,6 +20,10 @@ else docker_sock="//var/run/docker.sock" fi +echo "WARNING: This script is being deprecated and will be removed in a future release." +echo " Please install uv (https://docs.astral.sh/uv/getting-started/installation)" +echo " and then run 'uv tool install buildrunner' or 'uvx buildrunner' as documented" +echo " here: https://github.com/adobe/buildrunner/blob/main/docs/installation.rst" docker run \ $env_vars \ -v /$HOME:$HOME \ diff --git a/scripts/buildrunnerOSXCredStore b/scripts/buildrunnerOSXCredStore index ad41d23..e8a1592 100755 --- a/scripts/buildrunnerOSXCredStore +++ b/scripts/buildrunnerOSXCredStore @@ -28,6 +28,10 @@ else docker_sock="//var/run/docker.sock" fi +echo "WARNING: This script is being deprecated and will be removed in a future release." +echo " Please install uv (https://docs.astral.sh/uv/getting-started/installation)" +echo " and then run 'uv tool install buildrunner' or 'uvx buildrunner' as documented" +echo " here: https://github.com/adobe/buildrunner/blob/main/docs/installation.rst" docker run \ $env_vars \ -v /$HOME:$HOME \