Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

qa: Run QA directly from GitHub #800

Open
5 tasks
romac opened this issue Jan 23, 2025 · 0 comments
Open
5 tasks

qa: Run QA directly from GitHub #800

romac opened this issue Jan 23, 2025 · 0 comments
Assignees
Labels
performance Performance tracking and optimizations qa Quality & Assurance
Milestone

Comments

@romac
Copy link
Member

romac commented Jan 23, 2025

Description

Currently running QA experiments requires local setup and privileged access to DigitalOcean. To improve the QA process and make it easier to test the impact of code changes on performance and stability, we should add the ability to trigger QA runs directly from GitHub, either through workflow triggers or PR comments.

Proposed Solution

Add GitHub Actions workflow(s) that:

  1. Can be triggered either:

    • Manually via a workflow_dispatch event (ie. a manual workflow trigger)
    • By commenting /run-qa on a PR
    • Those should be only available to some privileged users to prevent abuse
  2. Runs the QA experiments on DigitalOcean

    • Create the necessary machines
    • Run QA
    • Tear down the machines
    • Alternatively, we could only allow a single QA run at a time and re-use the existing machines
  3. Uploads results as GitHub artifacts

    • Store metrics (Prometheus DB), logs, and other relevant outputs
    • Generate a comment on the PR with:
      • Summary of key metrics
      • Link to download full artifacts
      • Any failed checks or warnings

Benefits

  • Faster feedback loop for changes
  • No need for local setup
  • Consistent testing environment
  • Easy access to results for reviewers
  • Historical record of experiment results

Acceptance Criteria

  • QA runs can be triggered from GitHub UI
  • PR comments can trigger runs
  • Results are automatically uploaded as artifacts
  • Clear feedback provided in PR comments
  • Proper error handling and reporting

Questions

  • How long should we retain artifacts?
@romac romac added performance Performance tracking and optimizations qa Quality & Assurance labels Jan 23, 2025
@romac romac added this to the Phase 5 milestone Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
performance Performance tracking and optimizations qa Quality & Assurance
Projects
None yet
Development

No branches or pull requests

3 participants