Mod Commit Messages

[Pashaminkovsky]

User Story

As a mod developer, I want an optional field in which to write a commit message when I save a mod in the Page Editor. If I write a commit message, the version number of the mod will be incremented.

As a mod developer, I want to see the commit message for a mod in the following places:

1. Extention Console: Workshop > Edit Package > History
2. Admin Console: Deployments
3. Page Editor (last 3 commit messages and associated timestamps)

Motivation

"It's impossible to collaborate with someone when building mods and updating versions without commit messages (even going back to old mods yourself hard to keep track of updates)"

This would accelerate starter mod development and help maintain sanity. This is both an app change and an extension change.

Acceptance Criteria

Scenarios:

1. Saving a mod in the page editor.

• Given a mod is in a dirty state in the page editor
• When I click save
• Then I should have an optional text box to input a commit message and increment the version number.

2. Viewing commit messages in Workshop

• Given I saved a mod with a commit message
• When I visit the Workshop History to diff versions of a mod
• Then the associated commit message (if any) should appear above each panel.

3. Viewing commit messages in Deployments

• Given I saved a mod with a commit message
• When I visit the Deployments table
• Then the associated commit message (if any) should be visible in a column next to "Version"

4. Viewing commit messages in Deployment Details

• Given I saved a mod with a commit message
• When I visit the Deployments Detail View
• Then the associated commit message (if any) should be visible in field under "Version"

5. Viewing commit messages in the Page Editor

• Given I saved a mod with a commit message
• When I select the mod in the Page Editor
• Then the previous 3 commit messages (if any) and their Versions should be visible in the Mod Metadata

Designs: we can go with whatever is the lowest eng lift; no need to overthink it. As long as the data exists in a relatively usable way that's sufficient.

Slack discussion: https://pixiebrix.slack.com/archives/C042CA15AKS/p1730934129875419