Add GitHub Actions documentation for quickstart image #702
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: sagpatil <[email protected]>
Copilot
AI
changed the title
Copilot finished work on behalf of
sagpatil
July 10, 2025 19:36
ifropc
reviewed
Jul 10, 2025
README.md
Outdated
| - name: Start Stellar network | ||
| uses: stellar/quickstart@main | ||
| with: | ||
| network: "local" |
There was a problem hiding this comment.
Should not list network and enable here because it uses default values anyway.
Otherwise very good description
leighmcculloch
approved these changes
Jul 10, 2025
README.md
Outdated
Comment on lines
171
to
185
| ```yaml | ||
| - name: Run Stellar quickstart | ||
| uses: stellar/quickstart@main | ||
| with: | ||
| tag: "latest" # Image tag (default: "latest") | ||
| image: "docker.io/stellar/quickstart" # Image name (default: "docker.io/stellar/quickstart") | ||
| network: "local" # Network: local, testnet, futurenet (default: "local") | ||
| enable: "core,horizon,rpc" # Services to enable (default: "core,horizon,rpc") | ||
| enable_logs: "true" # Enable container logs (default: "true") | ||
| ``` | ||
|
|
||
| **Advanced Health Check Options:** | ||
| - `health_interval`: Time between health checks in seconds (default: "10") | ||
| - `health_timeout`: Maximum time for each health check in seconds (default: "5") | ||
| - `health_retries`: Number of consecutive failures before marking unhealthy (default: "50") |
There was a problem hiding this comment.
Move the advanced health check options into the yaml block describing each config option.
There was a problem hiding this comment.
Moved the advanced health check options into the main YAML configuration block as requested. Commit 1bf7f9b
Co-authored-by: leighmcculloch <[email protected]>
auto-merge was automatically disabled
July 10, 2025 21:22
Head branch was pushed to by a user without write access
Copilot finished work on behalf of
leighmcculloch
July 10, 2025 21:23
leighmcculloch
approved these changes
Jul 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Usage Examples
Basic usage:
With configuration:
Full workflow example for testing:
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.