Skip to content

Examples in ci#76

Merged
jCabala merged 3 commits intomainfrom
examples-in-ci
Aug 15, 2025
Merged

Examples in ci#76
jCabala merged 3 commits intomainfrom
examples-in-ci

Conversation

@jCabala
Copy link
Copy Markdown
Member

@jCabala jCabala commented Aug 13, 2025

Overview:

  • Abstracted away common logic in example scripts
  • Cleaned up the prints in the example scripts
  • Updated validations at the end of example scripts
  • Added example scripts to CI
  • Created a dockerfile for frost-client CI

Once this is merged to main I will need one more PR to update the image link in the workflow (See TODO comment in client-commands workflow)

closes #33
closes #54

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I accidantelly pushed those files on one of the previous PRs

@jCabala jCabala marked this pull request as ready for review August 14, 2025 15:16
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR abstracts common logic from FROST client example scripts into reusable helper functions, improves error handling and validation, and adds the examples to CI for automated testing.

  • Extracted shared functionality into helper scripts for file management, server initialization, and client command execution
  • Enhanced error handling with strict bash options (set -euo pipefail) and improved validation of generated artifacts
  • Created a Docker-based CI workflow to run all examples automatically with proper dependency management

Reviewed Changes

Copilot reviewed 11 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
frost-client/examples/helpers/*.sh New helper scripts abstracting common functionality for file generation, server initialization, and client command execution
frost-client/examples/*/example.sh Refactored example scripts to use helpers with improved error handling and cleaner output
.github/workflows/*.yml New CI workflows for building Docker image and running examples
.docker/frost-ci.Dockerfile Docker image with pre-installed FROST dependencies for CI
frost-client/examples/README.md Documentation explaining how to run examples and development workflow

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

@edwin1729 edwin1729 dismissed their stale review August 14, 2025 21:03

Resolved

@edwin1729 edwin1729 self-requested a review August 14, 2025 21:03
edwin1729
edwin1729 previously approved these changes Aug 14, 2025
@jCabala jCabala merged commit cfd08d5 into main Aug 15, 2025
2 checks passed
@scaraven scaraven deleted the examples-in-ci branch August 15, 2025 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add the client examples to the CI Abstract away the frostd initialisation in the example scripts

4 participants