Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jul 10, 2025

Adds comprehensive documentation for the GitHub Action introduced in PR #671, making it discoverable for developers who want to use the quickstart image in their CI/CD workflows.

What's Added

  • New "Using in GitHub Actions" section in README.md with:
    • Supported platforms (Linux, macOS Intel) and limitations
    • Basic usage example
    • Complete configuration options reference
    • Advanced health check settings
    • Real-world workflow example for smart contract testing

Usage Examples

Basic usage:

- name: Run Stellar quickstart
  uses: stellar/quickstart@main

With configuration:

- name: Run Stellar quickstart
  uses: stellar/quickstart@main
  with:
    network: "local"
    enable: "core,horizon,rpc"

Full workflow example for testing:

- name: Start Stellar network
  uses: stellar/quickstart@main
  with:
    network: "local"
    enable: "core,horizon,rpc"

- name: Run contract tests
  run: |
    # Services available at:
    # - Horizon: http://localhost:8000
    # - RPC: http://localhost:8000/rpc  
    # - Friendbot: http://localhost:8000/friendbot

The documentation covers all available inputs and provides clear guidance on platform support, making the action easily discoverable and usable.

Fixes #684.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: sagpatil <1414227+sagpatil@users.noreply.github.com>
Copilot AI changed the title [WIP] Add docs for quickstart GitHub Action Add GitHub Actions documentation for quickstart image Jul 10, 2025
Copilot AI requested a review from sagpatil July 10, 2025 19:36
@sagpatil sagpatil marked this pull request as ready for review July 10, 2025 19:37
@sagpatil sagpatil enabled auto-merge (squash) July 10, 2025 19:38
Co-authored-by: leighmcculloch <351529+leighmcculloch@users.noreply.github.com>
auto-merge was automatically disabled July 10, 2025 21:22

Head branch was pushed to by a user without write access

@sagpatil sagpatil enabled auto-merge (squash) July 10, 2025 21:38
@sagpatil sagpatil merged commit 4b49cf3 into main Aug 12, 2025
189 of 190 checks passed
@sagpatil sagpatil deleted the copilot/fix-684 branch August 12, 2025 01:41
@github-project-automation github-project-automation bot moved this from Backlog (Not Ready) to Done in DevX Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Add docs for quickstart GitHub Action

4 participants