Changelog GeneratorOverview

Changelog Generator is an OutSystems Developer Cloud (ODC) web app that helps development teams track and communicate changes between asset revisions. By connecting to your tenant's Asset Repository API, it fetches available assets and their revision history, compares any two revisions, and generates a human-readable changelog automatically.

Key features:

• Browse all assets and their revisions in your tenant
• Compare any two revisions side by side
• Generate and store AI-assisted changelogs
• View and manage past comparison results

Prerequisites

• An ODC tenant with at least one published asset with multiple revisions
• An OAuth 2.0 client (Client ID + Client Secret) with access to the Asset Repository API
• The AssetRepositoryAPI base URL for your tenant

Setup GuideStep 1 — Create an API Client in the ODC Portal

The app authenticates with the Asset Repository API using OAuth 2.0 client credentials. You need to create a dedicated API client in the ODC Portal.

1. Log in to the ODC Portal.
2. Navigate to Identity & Access Management → API Clients (or Service Accounts, depending on your portal version).
3. Click Create API Client (or Add service account).
4. Give it a descriptive name, e.g. ChangelogGenerator.
5. Assign the required scopes/permissions — at minimum, read access to the Asset Repository API.
6. Save and copy the generated Client ID and Client Secret — the secret is only shown once.

7. Keep the Client Secret secure. Do not commit it to source control.

Step 2 — Configure the App Settings

After publishing the app to your stage, open the ODC Portal, navigate to your stage, and set the following Settings (Site Properties) for the Changelog Generator app:

Step 3 — Bootstrap Data

On first run, use the built-in bootstrap actions to populate the local asset and revision cache:

1. Open the app and log in.
2. Navigate to the Assets screen — this triggers the asset list to sync from the API.
3. Select an asset and open its Revisions — this syncs the revision list for that asset.

Step 4 — Generate a Changelog

1. Go to Asset Compare from the main menu.
2. Select the asset you want to compare.
3. Choose the old revision and the new revision.
4. Click Generate Changelog.
5. The result is displayed on screen and saved to Compare Results for future reference.

Roles & Access

The app uses ODC's built-in authenticated user model. Ensure users are granted access to the app in the ODC Portal under Access Control.

Notes & Limitations

• The changelog is generated by comparing the OML structure of two revisions. The quality of the output depends on the complexity of the changes between revisions.
• OAuth tokens are cached (AES-encrypted) to minimise API calls. The cache is refreshed automatically when the token expires.
• This app requires network access from your ODC stage to the Asset Repository API endpoint.