Setting release notes for builds in ADT
Overview
This guide explains how to set release notes for each build using the ADT Command Line Interface (CLI). By adding release notes, you can document changes, improvements, or fixes associated with a specific build version, making it easier for teams to track updates.
Prerequisites
Before proceeding, ensure that you:
Have ADT CLI downloaded and opened in a terminal.
Have an API key for authentication (refer to Manage multiple API keys document).
Command usage
To set release notes for a build, execute the following command:
.\BlackBoxCLI.exe build set-release-notes --string <your_release_notes> --version-id <your_version_id> --build-id <your_build_id> --namespace <your_namespace> --apikey <your_apikey>
| Main command | Sub command | Options and Parameters | |
|---|---|---|---|
| Name | Description | ||
build | set-release-notes | --string | Set the release notes or change list |
--apikey | Set the ADT game's API key. | ||
--version-id | Set the version ID. | ||
--build-id | Set the build ID. | ||
--namespace | Set the name of the namespace. |
Example usage
Suppose you want to set release notes stating "Fixed crash issue on startup" for a build with the following details:
Version ID: 12345
Build ID: 67890
Namespace: mygame-namespace
API Key: abcd1234
You would run:
.\BlackBoxCLI.exe build set-release-notes --string "Fixed crash issue on startup" --version-id 12345 --build-id 67890 --namespace mygame-namespace --apikey abcd1234
Ensure that release notes provide clear and concise information for easier tracking.
Use proper versioning practices to maintain consistency across builds.