Updating a runner version

Summary

It is always recommended that you keep your runner updated to receive the latest patches, features, and bug fixes. To see what's included in each update, you can refer to the runner changelog.

If you encounter issues with a runner, updating it to the latest version can help resolve the problem. Follow the steps below to update your runner.

Solution

1. Stop the Runner Before updating, ensure that the runner is stopped. The method to stop the runner depends on the type of runner you are using:

   • Linux Docker Runner:

     • Identify the existing Runner container. The below command will return the container ID and name of the runner container:

       1 docker container ls | grep runner

     • Stop the Runner container using the container ID or name retrieved from the above command:

       1 docker container stop <container_id_or_name>

     • Remove the Runner container:

       1 docker container rm <container_id_or_name>

   • Linux Shell, macOS, or Windows Runners:

     • Stop the process that is running the runner. This could be done via terminal, task manager, or service manager, depending on how the runner was originally initiated.

     • For Linux and MacOS, find the runner’s process ID (PID) and kill it:

       1 2 ps aux | grep -E 'java.*runner' kill <PID>

     • On Windows, use the Task Manager or PowerShell to stop the process.

2. Pull the Latest Runner Version Use the appropriate command for your runner type to download the latest version of the runner. Linux Docker Runner

   1 docker image pull docker-public.packages.atlassian.com/sox/atlassian/bitbucket-pipelines-runner

   Non-Docker Runners

   1. Linux Shell and MacOS

      1 curl -O https://product-downloads.atlassian.com/software/bitbucket/pipelines/atlassian-bitbucket-pipelines-runner.tar.gz

   2. Windows

      1 Invoke-WebRequest -Uri https://product-downloads.atlassian.com/software/bitbucket/pipelines/atlassian-bitbucket-pipelines-runner.zip -OutFile .\atlassian-bitbucket-pipelines-runner.zip

3. Start the Runner Restart the runner using the command provided in the Bitbucket UI when the runner was initially created. If you no longer have this command, you can create a new runner in the UI to retrieve a new command.