github.releases.previous_compare

Resolve the previous release/tag and compare it with the current release/tag.

Overview

Property	Value
Workflow type	Atomic
Library	App-github
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Organization UUID
actor	string	No	—	Actor initiating the workflow
workflow_run_id	string	No	—	Parent workflow run id
dry_run	boolean	No	—	Validate and plan without provider reads
github_connection_uuid	uuid	No	—	GitHub installation connection UUID
repository	string	Yes	—	Repository owner/name
current_ref	string	Yes	—	Current release tag, branch, or SHA
previous_ref	string	No	—	Explicit previous release tag, branch, or SHA
include_files	boolean	No	—	Include file-level changes in output when supported
max_commits	integer	No	—	Optional cap for returned commit summaries

Output Schema

Field	Type	Required	Default	Description
status	string	No	—	planned, compared, no_previous_release, or failed
repository	string	No	—	—
current_ref	string	No	—	—
previous_ref	string	No	—	—
base_commit_sha	string	No	—	—
head_commit_sha	string	No	—	—
ahead_by	integer	No	—	—
behind_by	integer	No	—	—
total_commits	integer	No	—	—
commits	list	No	—	—
files	list	No	—	—
compare_url	string	No	—	—
dry_run	boolean	No	—	—
warnings	list	No	—	—
failure_reason	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—
failed_at	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "github.releases.previous_compare",
  "initial_data": {
    "organization_uuid": "value",
    "repository": "value",
    "current_ref": "value"
  }
}