Skip to main content
Automated upgrade PRs let Relnx raise a pull request that bumps a tool to a newer version in a connected GitHub or GitLab repository. The PR description includes a Breaking Changes section summarising what changed between your current and target versions — so the review context lives right where you approve the upgrade.

​
When to use it

  • A tool you depend on shipped a new release and you want to upgrade with the breaking-change context attached, not in a separate browser tab.
  • You manage versions in Chart.yaml, terragrunt.hcl, or versions.json and want the bump prepared for you to review.

​
Prerequisites

  • An organisation with a connected GitHub or GitLab repository (Org → Repositories → Add GitHub Org or Add GitLab Connection). The connection supplies the credentials Relnx uses to open the PR.
  • Relnx must have detected the tool in that repo. After connecting, Relnx scans for dependencies in Chart.yaml, terragrunt.hcl, and versions.json and lists each one with its current version.

​
Open an upgrade PR

  1. In your organisation’s sidebar, open Repositories and select the connected repo to see its detected tools.
  2. Find a tool marked Update Available — you can narrow the list with the Upgrades Available filter — and click Upgrade.
  3. Under Select Version to Upgrade, pick the target version and click Create Upgrade PR.
While the PR is being raised the button shows Creating PR…; on success you see Pull request created successfully! with a View PR link. The tool then shows PR Pending until the PR is merged or closed. Behind that button, Relnx (acting as relnx-bot):
  • Creates a branch and updates the relevant file (Chart.yaml, terragrunt.hcl, or versions.json) to the target version.
  • Opens a PR labelled bot, auto-upgrade, dependencies.
  • Adds a ⚠️ Breaking Changes section to the description listing each breaking change between your current and target version, each with a link to the full feature details on Relnx.

​
Track the PR

The Upgrades tab in your organisation’s sidebar is the single place to track upgrade activity. It shows:
  • Needs Upgrade — detected tools that are behind
  • Open PRs — upgrade PRs Relnx has opened, kept in sync with GitHub/GitLab (open / merged / closed), with a badge counting how many are still pending
  • Recent Merges — recently merged upgrade PRs
  • Created Tickets — Jira/Linear tickets opened from releases (see Create Jira / Linear tickets), each linking to the issue

​
Notes

  • Relnx only opens the PR — it never merges. You review and merge as usual.
  • If the target version has no breaking changes recorded, the PR is created without the Breaking Changes section.