Skip to content

SW-166 — Add deployment idempotency and retry-safety documentation #347

Open

Description

@dDevAhmed

Summary

Document what developers should do when a Testnet deployment is interrupted after submission may have occurred. Avoid encouraging blind retries that can create duplicate contracts.

Workstream

  • Workstream: WS-DEPLOYMENT
  • Primary scope: docs/reference/commands.md; docs/reference/troubleshooting.md
  • Priority: P1
  • Difficulty: medium
  • Proposed points: 150

Scope

Base guidance on the actual Stellar CLI behavior and available transaction/contract identifiers. Do not claim the CLI can guarantee exactly-once deployment.

Acceptance Criteria

  • Docs distinguish pre-submission failure from uncertain post-submission outcome.
  • No instruction recommends blind automatic retry.
  • Manual verification steps are actionable and Testnet-specific.
  • Contract ID/transaction evidence is described accurately.
  • Command reference and troubleshooting remain consistent.

Dependencies

SW-165

Out of Scope

  • Mainnet deployment, hosted services, or credentials.
  • Unrelated architecture changes or dependency additions without justification.
  • Changes to existing contributor PRs or their ownership.

Definition of Done

  • Acceptance criteria have deterministic regression coverage.
  • Documentation is updated where public behavior changes.
  • Supported-platform CI passes.
  • Security and compatibility boundaries remain intact.

🏷 Labels

  • Stellar Wave (do not apply until activation is explicitly authorized)
  • type: docs
  • area: deployment
  • priority: P1
  • difficulty: medium
  • points: 150
  • workstream: deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions