UI5 Renovate Preset Config

A Renovate preset to keep your UI5 application up-to-date.

• UI5 Renovate Preset Config
  • Features
  • Usage
  • Usage in TypeScript Projects
  • Sample
  • Further Information
  • Support, Feedback, Contributing
  • Security / Disclosure
  • Code of Conduct
  • Licensing

Features

Automatically creates pull requests to your UI5 project whenever a new UI5 version is released.

Information on the currently used UI5 version is updated in the following files:

• ui5.yaml files
• HTML files
• manifest.json and CommonDataModel.json files

The UI5 Renovate Preset Config takes into account whether your project uses OpenUI5 or SAPUI5.

Usage

1. Set up Renovate for your repository.
2. Create a new file called renovate.json at the root level of your project.
3. Add the following content:

{
	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
	"extends": [
		"github>ui5/renovate-config"
	],
	"separateMinorPatch": true
}

Note: We recommend setting separateMinorPatch to true to create separate pull requests for patches and minor releases.

If your project should only consume Long-Term Support (LTS) releases, use the following content:

{
	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
	"extends": [
		"github>ui5/renovate-config:lts"
	],
	"separateMinorPatch": true
}

Usage in TypeScript Projects

UI5 TypeScript projects depend on type packages (@openui5/types or @sapui5/types) whose versions must match the UI5 framework version. By default, Renovate manages these npm packages independently from the OpenUI5 / SAPUI5 version references in ui5.yaml and HTML files. To keep them in sync, add packageRules to your renovate.json that:

1. Override the datasource of the types package to use the same custom OpenUI5 / SAPUI5 datasource, so Renovate proposes the same version for both.
2. Group the types package together with the OpenUI5 / SAPUI5 framework update into a single pull request.

OpenUI5

{
	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
	"extends": [
		"github>ui5/renovate-config"
	],
	"separateMinorPatch": true,
	"packageRules": [
		{
			"matchDepNames": ["@openui5/types"],
			"overrideDatasource": "custom.openui5",
		},
		{
			"matchDepNames": ["openui5", "@openui5/types"],
			"groupName": "openui5"
		}
	]
}

SAPUI5

{
	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
	"extends": [
		"github>ui5/renovate-config"
	],
	"separateMinorPatch": true,
	"packageRules": [
		{
			"matchDepNames": ["@sapui5/types"],
			"overrideDatasource": "custom.sapui5",
		},
		{
			"matchDepNames": ["sapui5", "@sapui5/types"],
			"groupName": "sapui5"
		}
	]
}

For LTS-only projects, replace the preset and datasource accordingly (e.g., github>ui5/renovate-config:lts and custom.openui5_lts / custom.sapui5_lts).

How it works: The overrideDatasource tells Renovate to resolve the types package version from the OpenUI5 / SAPUI5 version feed instead of the npm registry. The groupName ensures both the framework version and the types package are proposed in the same pull request, so your project stays consistent.

See the UI5 Tutorials renovate.json for a full working example.

Sample

See https://github.com/UI5/sample-app for a live demo of UI5 Renovate Preset Config.

In Action

The project was presented at UI5con 2025 during the "UI5 Tools - Update 2025" session. Watch the recording titled UI5 Renovate Preset Config at UI5con 2025 for further insights.

Further Information

• Renovate Docs

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports, etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project's structure, as well as additional contribution information, see our Contribution Guidelines.

You can also chat with us in the #renovate-config channel of the OpenUI5 Community Slack. For public Q&A, use the ui5-renovate-config tag on Stack Overflow.

Security / Disclosure

If you find any bug that might be a security problem, please follow the instructions given in Security Policy on how to report it. Please do not create GitHub issues for security-related concerns or problems.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2026 SAP SE or an SAP-affiliate company and contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.