- sara.next
- Technology
- Release notes
Technology · Documentation
Release notes
For an IT team, release notes are part of assessing the risk of a change — not just a list of new features.
- release notes
- assessing the risk of a change
- regression tests
- from working documentation — to be approved
Context
What release information should contain
For an IGA platform, an update may affect the approval process, the history of permissions, the way scripts are executed and integrations with target applications. Well-prepared release information should give the administrator a basis for assessing whether the change requires updating a connector, regression tests or a configuration change.
Below is the structure of sara.next release information. Entries are published after they have been approved and linked to an actual release artefact.
Categories
Categories of changes
New features
Changes to request processes, reviews, reports or administration.
Integration changes
REST/SQL, script variables, verification behaviour, connection compatibility.
Bug fixes
The scope of the correction and the observable behaviour before and after.
Security
The vulnerability category, the conditions under which it occurs and an update recommendation — without prematurely disclosing an exploit.
Administrator actions
Migrations, new settings, deprecations and post-deployment actions.
Known limitations
Issues that remain open, safe workarounds and how to escalate.
Format
Release entry format
Every entry has the same structure, so that information relevant to a specific environment can be found quickly.
| Entry section | Contents |
|---|---|
| Header | Version number, publication date and status: GA, security fix or maintenance release |
| Key changes | The change and its operational effect |
| Security | Description, classification and required action |
| Integrations | Changes to REST/SQL, Groovy and script behaviour |
| Compatibility | Versions of required components and dependencies |
| Update | Pre-deployment steps, migration, tests, rollback |
| Known limitations | Issues and workarounds |
| References | Identifiers of changes, tickets and documentation |
Assessment
What is particularly important for an IGA administrator
An update should be assessed in terms of three risks. When scripts change, test granting as well as modifying and revoking access.
Three update risks
- whether it changes the order of decisions in the workflow
- whether it changes the interpretation of existing permissions
- whether it affects the execution and verification of auto-implementation
Deployment
A practical way to deploy a version
- 01Release notes analysis
- 02Backup and rollback plan
- 03Test environmentUpdate.
- 04Sign-in and workflow tests
- 05Tests of key integrations
- 06Maintenance windowApproval.
- 07Production update
- 08Post-deployment testsAnd monitoring.
An implementation expert's view
Release quality is not measured by the number of new features
I do not judge the quality of a release by the number of new features. For an IGA platform, the ability to predict the impact on existing roles, automations and audit evidence is more important.
A good release note should tell the administrator clearly: what is changing, who it affects and what needs to be checked before deployment.
Contact the support team about the compatibility of your environment
We will discuss the impact of the update on roles, integrations and scripts in your deployment.