Create Release

Stable

Creating a release adds a new versioned snapshot to an existing mod in the registry. The release is created empty — with no assets, symbolic links, or mission scripts — and the maintainer populates it by updating it before publishing.

Property	Value
Applies to	Webapp
Trigger	An authenticated maintainer submits the create release form
Preconditions	The user is authenticated and is a maintainer of the mod

Inputs

modId : String, required. The identifier of the mod to create a release for.

version : String, required. The version string for the release (e.g. 1.0.0).

Assertions

Assertion	Status
The user must be authenticated	Implemented
The mod must exist in the registry	Implemented
The authenticated user must be a maintainer of the mod	Implemented

Outputs

Result<ModReleaseData, ModNotFoundError | NotMaintainerError> : On success, returns the created release record. On failure, returns one of the following error types:

ModNotFoundError : The mod does not exist in the registry.

NotMaintainerError : The authenticated user is not a maintainer of the mod.

Effects

Effect	Status
A new release record is created in the registry	Implemented
The release's initial visibility is set to `PUBLIC`	Implemented
The release is created with empty `assets`, `symbolicLinks`, and `missionScripts` lists	Implemented
A unique identifier is generated and assigned to the release	Implemented
A `versionHash` is generated and stored with the release	Implemented

Behavior

mermaid

flowchart TD
    Start([createRelease user data]) --> Authenticated{User authenticated?}

    Authenticated -- No --> Reject401([Reject: 401 Unauthorized])
    Authenticated -- Yes --> Exists{Mod exists?}

    Exists -- No --> ErrNotFound([Reject: ModNotFoundError])
    Exists -- Yes --> IsMaintainer{User is maintainer?}

    IsMaintainer -- No --> ErrNotMaintainer([Reject: NotMaintainerError])
    IsMaintainer -- Yes --> Create[Create release with PUBLIC visibility,<br/>empty assets/symlinks/scripts,<br/>new versionHash]

    Create --> Done([Release created])

    style Reject401 fill:#f87171,color:#fff
    style ErrNotFound fill:#f87171,color:#fff
    style ErrNotMaintainer fill:#f87171,color:#fff
    style Done fill:#4ade80,color:#000

Create Release ​

Inputs ​

Assertions ​

Outputs ​

Effects ​

Behavior ​