0Pricing
Erlang OTP: Distributed & Fault-Tolerant Systems Programming · Lesson

Release Versioning & Deployment

Understand best practices for versioning releases, deploying updates, and managing rollbacks in a production environment.

Release Versioning & Deployment is a free Erlang OTP: Distributed & Fault-Tolerant Systems Programming lesson on CoddyKit — lesson 3 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Erlang OTP: Distributed & Fault-Tolerant Systems Programming learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Why Version Your Releases?

When you build an Erlang application for production, it's bundled into a release. Just like any software, releases need clear version numbers.

Versioning helps you:

  • Track changes over time.
  • Identify specific builds.
  • Manage compatibility with other systems.
  • Plan for upgrades and rollbacks.

Erlang's Versioning System

In Erlang, versioning happens at different levels. Each individual application (an .app file) has its own version. The overall release (the .rel file) also has a version that typically reflects the entire bundle.

The vsn key in an .app file defines an application's version.

% my_app.app file (conceptual)
{application, my_app,
 [{description, "My Erlang Application"},
  {vsn, "1.0.0"},
  {modules, [my_app_app, my_app_sup]},
  {registered, []},
  {applications, [kernel, stdlib]},
  {mod, {my_app_app, []}},
  {env, []}]}.

Semantic Versioning (SemVer)

A widely adopted standard is Semantic Versioning (SemVer), typically formatted as MAJOR.MINOR.PATCH. It's a great practice to follow for your Erlang applications.

  • MAJOR: Incremented for incompatible API changes.
  • MINOR: Incremented for new functionality in a backward-compatible way.
  • PATCH: Incremented for backward-compatible bug fixes.

This helps users understand the impact of an upgrade.

Applying SemVer in Erlang

You'll typically apply SemVer to your application's vsn in the .app file. When you create a release, its version (relvsn) often matches the main application's version or follows a similar scheme.

Tools like rebar3 manage these versions when building releases.

% my_app.app file
{application, my_app,
 [{description, "My Erlang Service"},
  {vsn, "1.2.3"},
  {modules, [my_app_app, my_app_sup]},
  {registered, []},
  {applications, [kernel, stdlib]},
  {mod, {my_app_app, []}},
  {env, []}]}.

Deployment Strategies Overview

Once you have a versioned Erlang release, how do you get it running in production? There are several strategies, depending on your system's requirements for uptime and complexity.

  • Cold Deployment: Simplest, involves downtime.
  • Hot Upgrades: Zero-downtime (covered in previous lesson).
  • Blue/Green or Canary Deployments: More advanced, often used with orchestration tools.

Cold Deployment: Simple Restart

A cold deployment is the most straightforward method. You stop your currently running Erlang system completely, replace its files with the new release, and then start the new version.

This method always incurs downtime, making it suitable for systems where brief interruptions are acceptable.

# Stop the old release
/path/to/my_app/bin/my_app stop

# (Replace files with new release)

# Start the new release
/path/to/my_app/bin/my_app start

Hot Upgrades vs. Full Deployment

Recall from the previous lesson that hot code loading allows you to upgrade a running Erlang system without stopping it.

While powerful for applying patches or minor feature additions, hot upgrades are specific to changing *parts* of a running system. A full deployment often refers to the initial setup or a complete replacement of the entire release, sometimes involving a cold restart or more advanced traffic management.

The Importance of Rollbacks

Even with careful testing, new deployments can introduce unexpected issues. A robust deployment strategy always includes a plan for rollbacks.

A rollback means reverting your system to a previous, stable version if the new deployment fails or causes problems. This minimizes the impact of failures and restores service quickly.

Erlang's Rollback Mechanism

Erlang releases are designed to support rollbacks. When you perform a hot upgrade, Erlang generates an .relup script that describes how to move between versions. Crucially, it also knows how to reverse that script to go back.

Even with cold deployments, you can switch back to a previous release by managing your release directories and restarting the desired version.

# Example of a rollback command using release_handler
# This would typically be part of a custom script or release tool

% release_handler:install_release("my_app-1.1.0").
% release_handler:make_permanent("my_app-1.1.0").

# Alternatively, for cold deployment:
# /path/to/my_app_1.1.0/bin/my_app start

Test Your Understanding

Order the steps for a typical cold deployment of an Erlang release.

Summary: Versioning & Deployment

You've learned about the critical aspects of release versioning and deployment in Erlang:

  • Versioning: Use vsn in .app files, ideally following SemVer (MAJOR.MINOR.PATCH), to track and manage changes.
  • Deployment: Understand cold deployment (with downtime) and its distinction from hot upgrades.
  • Rollbacks: Always plan for reverting to a stable previous version to ensure system resilience.

These practices are key to managing robust Erlang applications in production!

Frequently asked questions

Is the “Release Versioning & Deployment” lesson free?

Yes — the full text of “Release Versioning & Deployment” is free to read here on the web, and the Erlang OTP: Distributed & Fault-Tolerant Systems Programming course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Erlang OTP: Distributed & Fault-Tolerant Systems Programming course, upgrade to CoddyKit PRO.

What will I learn in “Release Versioning & Deployment”?

Understand best practices for versioning releases, deploying updates, and managing rollbacks in a production environment. You practise Erlang OTP: Distributed & Fault-Tolerant Systems Programming with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start Erlang OTP: Distributed & Fault-Tolerant Systems Programming?

No prior experience is required. Erlang OTP: Distributed & Fault-Tolerant Systems Programming on CoddyKit is structured for beginners through advanced learners; this is — lesson 3 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Release Versioning & Deployment” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this Erlang OTP: Distributed & Fault-Tolerant Systems Programming lesson?

Yes. Every Erlang OTP: Distributed & Fault-Tolerant Systems Programming lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

  1. Creating Erlang Releases
  2. Hot Code Loading & Upgrades
  3. Release Versioning & Deployment
  4. Release Configuration & Boot Scripts
← Back to Erlang OTP: Distributed & Fault-Tolerant Systems Programming