Changelog

What’s New

The quarterly update across Linux images is now available. In addition to standard software updates, the following changes have been made:

• Heroku has been removed
• Java 11 has been removed and replaced by Java 17

For more details on this release, refer to the Discuss post.

What’s New

CircleCI’s CLI now includes an env subst command, which serves as a wrapper around the popular envsubst CLI tool. The command is used to substitute environment variables in a text string or file.

circleci env subst is available in both the local CLI and inside all CircleCI jobs (coming to CircleCI server v4.2+). More information and usage examples can be found in the docs as well as in this Discuss post.

Before Upgrading

See the CircleCI server 4.1 release notes for upgrade notes for this release.

When upgrading from server v3.x you will need to install v4.0 before installing this version.

What’s New in Release 4.1.2

Changes

• We have updated our PostgreSQL password requirements to allow special characters (except single or double quotes) in addition to alphanumeric characters.

Fixes

• For runner installations on server, you can now directly clone a repository with just the checkout step in .circleci/config.yml.

Known Issues

• Vault may not refresh its client token after a month of uptime.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for public installations, but for private installs you would need to ensure that you can access the private IP advertised. For example, by using a VPN into your VPC.
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.

To learn more about Server 4.1 installation, migration, or operations please see our documentation.

Before upgrading

See the CircleCI server 4.0 release notes for upgrade notes for this release.

What’s new in release 4.0.4

Changes

• We have updated our PostgreSQL password requirements to allow special characters (except single or double quotes) in addition to alphanumeric characters.

Fixes

• For runner installations on server, you can now directly clone a repository with just the checkout step in .circleci/config.yml.

Known issues

• When migrating from 3.x to 4.x, workflow configuration migrations will run as an init job and the workflows-conductor-event-consumer and the workflows-conductor-grpc-handler pods will not start until the migration completes. Customers with large PostgreSQL databases should plan accordingly. Migration time can be reduced by scaling the workflow-conductor pods.
• Vault may not refresh its client token after a month of uptime.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for public installations, but for private installs you would need to ensure that you can access the private IP advertised. For example, by using a VPN into your VPC.
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.

To learn more about Server 4.0 installation, migration, or operations please see our documentation.

What’s New

We now offer a way for you to immediately delete a DLC cache’s contents. You can do so via the CircleCI web UI, or the CLI. Refer to this support article for details.

When using Docker layer caching (DLC), a project’s cache can occasionally become corrupted, leading to failed jobs. Previously, the only solution was to stop using DLC, wait 3 days for the cache to become invalid, then turn DLC back on.

Before upgrading

See the CircleCI server 4.0 release notes for upgrade notes for this release.

What’s new in release 4.0.3

Changes

• In the checkout step in a CircleCI configuration, GitHub host keys are appended to ~/.ssh/known_hosts. Due to a change to GitHub’s RSA SSH key, CircleCI have updated the appended key to match. If you are using GitHub.com, and your installation of server has the old host key hardcoded into any projects, you will also need to update these to match.

Known issues

• When migrating from 3.x to 4.x, workflow configuration migrations will run as an init job and the workflows-conductor-event-consumer and the workflows-conductor-grpc-handler pods will not start until the migration completes. Customers with large PostgreSQL databases should plan accordingly. Migration time can be reduced by scaling the workflow-conductor pods.
• Vault may not refresh its client token after a month of uptime.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for public installations, but for private installs you would need to ensure that you can access the private IP advertised. For example, by using a VPN into your VPC.
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.

To learn more about Server 4.0 installation, migration, or operations please see our documentation.

Before Upgrading

See the What’s new in server 3.x doc for upgrade notes for this release.

What’s New in Release 3.4.6

Changes

• In the checkout step in a CircleCI configuration, GitHub host keys are appended to ~/.ssh/known_hosts. Due to a change to GitHub’s RSA SSH key, CircleCI have updated the appended key to match. If you are using GitHub.com, and your installation of server has the old host key hardcoded into any projects, you will also need to update these to match.

Known Issues

• webhook-service is not operational when Vault is externalized.
• Vault may not refresh its client token after a month of uptime.
• Before upgrading to v3.4.x, delete the deployment named circleci-server-kube-state-metrics.
• Prometheus is broken in KOTS versions 1.65.0 - 1.67.0. If you rely on this feature, do not upgrade your KOTS version until this issue has been resolved.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for private installations, but for public installations you would need to ensure that you can access the private IP advertised (for example, by using a VPN into your VPC).
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.
• The KOTS admin console cannot be upgraded if your installation is set up to be behind a proxy. The proxy settings will be deleted and cause the KOTS admin console to break.

To learn more about Server 3.x installation, migration, or operations please see our documentation.

Before Upgrading

See the CircleCI server 4.1 release notes for upgrade notes for this release.

When upgrading from server v3.x you will need to install v4.0 before installing this version.

What’s New in Release 4.1.1

Changes

• In the checkout step in a CircleCI configuration, GitHub host keys are appended to ~/.ssh/known_hosts. Due to a change to GitHub’s RSA SSH key, CircleCI have updated the appended key to match. If you are using GitHub.com, and your installation of server has the old host key hardcoded into any projects, you will also need to update these to match.

Known Issues

• Vault may not refresh its client token after a month of uptime.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for public installations, but for private installs you would need to ensure that you can access the private IP advertised. For example, by using a VPN into your VPC.
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.

To learn more about Server 4.1 installation, migration, or operations please see our documentation.

Before Upgrading

See the CircleCI server 4.1 release notes for upgrade notes for this release.

When upgrading from server v3.x you will need to install v4.0 before installing this version.

What’s New in Release 4.1.0

New features

• Air-gapped installation is now supported on server v4.1.
• Self-signed certificates or private certificate authorities are now supported when using GitHub Enterprise.
• For new installations, Tink can be used as the encryption backend instead of Vault.

Changes

• The minimum Telegraf version is now set to 1.8.14.
• Nomad and Vault images are now stored in templates, rather than hardcoded in charts.
• The Nomad Terraform configurations now have the Nomad port hardcoded. Previously this needed to be entered manually.

Database Migrations

The following databases will run migrations when upgrading this version.

• builds_service
• branch_service
• contexts_service_production
• orbs
• orb_analytics
• permissions
• webhook_service
• conductor_production

Fixes

• The Trigger Pipeline button in the web app now works for forked PRs, and an error message will be visible if the trigger fails.
• Fixed a bug that was preventing forked PRs from building if both the fork and original were building on CircleCI.
• Fixed a bug that was causing intermittent status updates for jobs in GitHub.

Known Issues

• Vault may not refresh its client token after a month of uptime.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for public installations, but for private installs you would need to ensure that you can access the private IP advertised. For example, by using a VPN into your VPC.
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.

To learn more about Server 4.x installation, migration, or operations please see our documentation.

What’s New

CircleCI now offers Apple Silicon M1 support on our macOS executor. Customers on annual plans can take advantage of the improved performance by updating their config to resource_class: macos.m1.large.gen1.

Learn more by reading our announcement and documentation.

What’s New

The job status badges in the CircleCI UI now include a badge for “Infrastructure Failure”. This badge indicates that CircleCI has run into issues with the underlying infrastructure on which the job runs.

Previously, it was difficult for users to discern whether a job failed due to an infrastructure failure, or another cause such as a test failure. This change allows for more transparency about what happens with the execution of jobs.

Refer to the Discuss post for an example.

What’s New

Visual Studio Code users can now re-run CircleCI jobs with SSH, through either the integrated terminal, or a dedicated remote development window. You can automatically open an SSH connection within the terminal, or use a remote window to work on a CircleCI remote machine as if it was a VS Code workspace, which allows you to browse and view files easily, as well as take advantage of supported extensions.

For more details, see the Discuss post (including a quick demo), or the docs on VS Code Marketplace.

What’s New

Updated Android images for both the Docker and machine executors are now available.

Note that the Docker image has been migrated to Ubuntu 22.04. The machine image remains on Ubuntu 20.04 and will be migrated to 22.04 in the next month. For more details, refer to the Discuss post.

What’s New

The Q1 update for Linux images is now available, using the following image tags:

• ubuntu-2004:2023.02.1
• ubuntu-2204:2023.02.1

This refresh includes standard software updates. Heroku will be deprecated leading into the Q2 updates for Linux images. For more details, refer to the Discuss post.

Before Upgrading

See the What’s new in server 3.x doc for upgrade notes for this release.

What’s New in Release 3.4.5

Fixes

• Patched some CVEs.
• Updated runner’s launch-agent to use a query string instead of a GET body.

Known Issues

• webhook-service is not operational when Vault is externalized.
• Vault may not refresh its client token after a month of uptime.
• Before upgrading to v3.4.x, delete the deployment named circleci-server-kube-state-metrics.
• Prometheus is broken in KOTS versions 1.65.0 - 1.67.0. If you rely on this feature, do not upgrade your KOTS version until this issue has been resolved.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for private installations, but for public installations you would need to ensure that you can access the private IP advertised (for example, by using a VPN into your VPC).
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.
• The KOTS admin console cannot be upgraded if your installation is set up to be behind a proxy. The proxy settings will be deleted and cause the KOTS admin console to break.

To learn more about Server 3.x installation, migration, or operations please see our documentation.

What’s New

Fail fast reduces wasted time and helps you optimize credit usage.

Configure your testing jobs to stop executing shortly after finding the first test failure, even in jobs where parallelism is enabled.

You can read more about the fail fast open preview in the Discuss post, and in the documentation.

What’s New

A bug has been fixed in the circle-android utility in the machine image used in the Android orb, where the wait-for-boot step would hang.

The Android cimg and machine images will both be built using Ubuntu Jammy 22.04 in the near future.

Visit the Discuss post for more information.

Before upgrading

See the CircleCI server 4.x release notes for upgrade notes for this release.

What’s new in release 4.0.2

Changes

• Pin Bitnami Postgres Helm chart url

Known issues

• When migrating from 3.x to 4.x, workflow configuration migrations will run as an init job and the workflows-conductor-event-consumer and the workflows-conductor-grpc-handler pods will not start until the migration completes. Customers with large PostgreSQL databases should plan accordingly. Migration time can be reduced by scaling the workflow-conductor pods.
• Vault may not refresh its client token after a month of uptime.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for public installations, but for private installs you would need to ensure that you can access the private IP advertised. For example, by using a VPN into your VPC.
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.

To learn more about Server 4.x installation, migration, or operations please see our documentation.

What’s New

We have added out-of-the-box shell support for Node and Ruby. Invoking Node and Ruby commands within CircleCI jobs can now be as simple as the following:

steps:
  - run:
    name: Check Node shell
    shell: node
    command: console.log("node")

Usage examples in other languages can be found in our documentation.

Before Upgrading

See the What’s new in server 3.x doc for upgrade notes for this release.

What’s New in Release 3.4.4

Fixes

• Fixed a bug that was causing delays and failures to update git commit statuses.

Known Issues

• webhook-service is not operational when Vault is externalized.
• Vault may not refresh its client token after a month of uptime.
• Before upgrading to v3.4.x delete the deployment named circleci-server-kube-state-metrics.
• Prometheus is broken in KOTS versions 1.65.0 - 1.67.0. If you rely on this feature, do not upgrade your KOTS version until this issue has been resolved.
• Retry with SSH for jobs using the machine executor advertises a private IP address. For this reason, retry with SSH for jobs using the machine executor works as standard for private installations, but for public installations you would need to ensure that you can access the private IP advertised. For example, by using a VPN into your VPC.
• CircleCI 1.0 builds are not supported. If an attempt is made to run a 1.0 build, no feedback will be available in the application to indicate the cause of the issue. If a build is run on your installation and does not show up in the CircleCI application, users should be directed to use the CircleCI CLI to validate the project configuration and get details of the possible cause of the issue.
• The KOTS admin console cannot be upgraded if your installation is set up to be behind a proxy. The proxy settings will be deleted and cause the KOTS admin console to break.

To learn more about Server 3.x installation, migration, or operations please see our documentation.

What’s New

The CircleCI VS Code extension is now generally available. This extension provides an interface to visualize and manage CircleCI pipelines directly from VS Code. It also offers contextual help when creating, modifying, and editing CircleCI YAML configuration files.

By making existing CircleCI features available in VS Code and facilitating configuration file editing, the extension reduces context switching for CircleCI users (i.e. between the code editor and the browser).

Head to the VS Code Marketplace to view the full list of capabilities and download the extension for free.

What’s New

We have published the official CircleCI Visual Studio Code extension. This extension provides an interface to visualize and manage CircleCI pipelines directly from VS Code. It also offers contextual help when creating, modifying, and editing CircleCI YAML configuration files.

By making existing CircleCI features available in VS Code and facilitating configuration file editing, the extension reduces context switching for CircleCI users (i.e. between the code editor and the browser).

Head to the VS Code Marketplace to view the full list of capabilities and download the extension for free. The CircleCI VS Code extension is currently in open preview.

What’s New

A new set of convenience images have been developed that focus specifically on deployment.

• cimg/deploy
• cimg/aws
• cimg/azure
• cimg/gcp

For more information, visit the Discuss post.

What’s New

Image updates for Windows Server 2022, including a variety of package updates as well as the lastest release of current.

For a full list of updated packages and examples using current, visit the Discuss post.

What’s New

Container runner, a more scalable and container-friendly self-hosted runner, has moved out of the open preview stage and is now in general availability.

Find more information about the release of container runner in the Discuss post. Read more about container runner in CircleCI’s documentation.

What’s New

The quarterly (Q4) revision updates package versions for the Linux family of images. The updated Ubuntu 20.04 and Ubuntu 22.04 images are both available on amd64 and arm64 architecture. Images can be accessed with the following tags:

ubuntu-2004:2022.10.1 ubuntu-2204:2022.10.1

More details can be found in the 2022 October (Q4) Update Discuss post.