CI/CD With GitHub Actions

Why Use GitHub Actions?

GitHub Actions provides a powerful and flexible way to automate software development workflows. With GitHub Actions, you can perform various automated tasks, such as building, testing, and deploying your code directly from your GitHub repository. This can save time and reduce errors by automating repetitive tasks and enabling faster feedback loops. For example, you can configure your workflow to automatically build and test your code whenever a pull request is opened. This can help catch bugs and issues earlier in the development process.

Supercharge Your Development Workflow With Scorecard’s GitHub App

The Scorecard AI Github App

Integrating Scorecard AI with GitHub supercharges your software development workflow. By leveraging Scorecard’s capabilities within your GitHub repository, you can automatically run end-to-end tests, analyze system behavior, and obtain actionable insights—all in an automated manner. Imagine a scenario where every pull request is automatically assessed by Scorecard, presenting comprehensive test results and feedback directly in GitHub.

Benefits of Integration

• Automated Testing: For every push or pull request, Scorecard can automatically perform extensive end-to-end tests.
• Instant Feedback: Obtain direct feedback on your PRs in GitHub, making it easier to catch and rectify issues before they reach production.
• Continuous Monitoring: With Scorecard, you can monitor application behavior, ensuring it aligns with expected outcomes.

How To Setup the GitHub Scorecard Integration

1. New Integration

• Navigate to the dashboard in the Scorecard UI.
• Click on the “Integrate GitHub” button.
• You’ll be redirected to GitHub. Here, you can choose which repository to use.

2. Configuration

• In your GitHub repository, find the Scorecard configuration file at .github/workflows/scorecard-eval.yml
• Update your testing parameters and triggering conditions, as well as any necessary secret key configurations in this file.
• In your GitHub repository, find the run_tests.py. Within the ‘run_all_tests’ function update your "model_response" to point to your actual system’s call.

3. Triggering Tests

• Once integrated, every push or PR automatically triggers Scorecard tests based on your configuration.
• Test results and feedback will be directly posted on the respective PR or push event in GitHub.

4. Customization

• Use the Scorecard UI dashboard to customize testing behaviors, set up notifications, and more.