Versioning
All applications start in SuperOffice Online Development (SOD) and might eventually go live (via our stage environment). The application configuration has to be approved to move to the next environment. For standard apps entering the App Store, the App Store information must also be approved.
To keep track of what currently is (or is desired to be) active in each environment we use versions.
What is a version?
A version is a labelled snapshot of the app configuration or the App Store information.
The initial version is automatically published to SOD. You can then:
- Update the initial version
- Create a new version
- Publish the new version to SOD yourself
- Request to publish a version to stage
In SOD, a version is a draft and can be edited until you request to publish it to stage. Then it is locked. If we reject it, the version is unlocked and you can update it to fix any issues.
Watch the walk-through on YouTube:
States
| State | Color | Description |
|---|---|---|
| Draft | A new version that can be edited. | |
| Published | green | The version is currently active for the environment. |
| Request pending | yellow | Someone has requested to publish this version to an environment. |
| Rejected | red | The version was not approved for the requested environment. |
Where are my versions?
The Overview section of the app page and partner page shows the current state of the app configuration and the App Store information per environment. From this overview, you can click any version to open it.
To see all versions of a section, select that section and click More versions
Edit version
All changes happen in SOD!
- Pending versions can't be changed.
- Rejected versions can be edited and saved in SOD.
- Versions published to stage and/or production can't be changed.
To make changes:
- Locate the version you want to update either from the Overview, App Store information, or Configuration section.
- If it is locked, create a new version.
- Change the configuration or information you want and click Save Settings.
Note
Some settings can be configured per environment. A single configuration will then hold multiple values of that setting. For example, if you have environment-specific certificates you handle this within one configuration and request it published to Stage and Production. Don't confuse settings per environment with versions per environment.
Create new version
Locate the version you want to update either from the Overview, App Store information, or Configuration section.
Click More versions.
Click Add New Configuration or New App Store Change depending on your context.
Enter a label and click the green checkmark.
The new version appears in the list and you can select it to edit.
Compare versions and track changes
We keep a change log per version. When someone clicks Save Settings, a new entry is added.
To access the log, locate the version. It shows up automatically, for the selected version.
If the wrong version is showing, click More versions and select the one you want to view.
If the change log is empty, it means that there are no changes since that version was created or that the changes happened before August 2022.
At the end of each entry is a link to download a JSON file representing that state.
To create a diff, download the JSON file for each of the two variants you want to compare and runt the files through a tool such as JSON Diff.
You can for example compare to variants of the same version or compare the current draft against the published version in Stage or Prod.
Request to publish
When you think it is ready in SOD, you can request to publish to Stage. This starts the certification or validation process, so read the guidelines and be prepared to follow up.
The SuperOffice app manager or App Store manager will reject or approve.
Remember to pick up application keys for all required environments before you request to publish.
For custom applications, when you request publish to Stage, we will automatically publish directly to production when approved.
- If your version was approved for Stage, you can test it there before requesting to publish to production.
- If your version was rejected for Stage, you need to fix the problems in SOD and then request to publish again.