Add Release Notes to your application 🆕
Hi Industrial Edge app developers 💻,
as part of the September 2025 release, the Industrial Edge Management will be able to display your Device Application's release notes for each version!
Why this matters
This enhancement empowers you to better communicate with your users. Release notes are crucial for informing them about changes in new or updated software versions. They typically highlight:
- New features
- Bug fixes
- Performance improvements
- And any other notable changes in your app version.
By making these accessible directly within IEM, users can quickly understand the value and updates you bring with each release.
How to prepare: Providing your release notes
To ensure your release notes display correctly in the new IEM UI, please follow these guidelines:
1. Format
All release notes must be provided in Markdown (.md) format
2. Submitting release notes
using IECTL
If you are creating the app version using IECTL, you can use the following parameter:
--changelogs "$(cat releasenotes.md)"
using IEAP
If you are creating the app version using IEAP, please add the release notes here:
3. For external release notes
If you manage your release notes on an external platform (e.g. your own website), we recommend including 1-3 key highlights of the app version directly in the IEM release notes. Then, redirect users to your full documentation. For example:
"Discover all the improvements and more! Visit our full release notes: docs.industrial-operations-x.siemens.cloud 🚀"
Please be aware, that external URLs are not supported in the release notes section of IEM.
Outlook
Displaying release notes in IEM is just the first step. We are also planning to extend this functionality to IE Hub in the near future. Stay tuned for more updates!
Questions?
If you have any questions, feel free to get in touch!