CI Actions

Contents

• 📙 Overview of this Repository
• 👊 Available In-House GitHub Actions
• ❓ How to Use One or More In-House GitHub actions
• 📬 Contributing

📙 Overview of this Repository

This repository contains reusable, in-house GitHub actions that are specific to the InstructLab org. None of the GitHub actions provided here will be published to the GitHub Marketplace, but if you would like to use these actions in your own GitHub repo or org, feel free to use them as you see fit.

👊 Available In-House GitHub Actions

Below is a list of the in-house GitHub actions stored in this repository:

Name	Description	Example Use Cases
detect-exposed-workflow-secrets	Used to detect when a contributor's PR would expose a GitHub secret through one or more workflow files that auto-trigger on PRs, and aborts that contributor's PR build before it can start.	Prevent accidental secrets exposure through GitHub workflow files that auto-trigger on PR builds.
free-disk-space	Used to reclaim disk space on either a GitHub or EC2 runner.	If a CI job tends to fail due to "insufficient disk space" If you want to reduce cloud costs by reclaiming disk space instead of increasing your writeable cloud storage to compensate for a bloated EC2 image
launch-ec2-runner-with-fallback	Used launch an EC2 instance in AWS, either as a spot instance or a dedicated instance. If your preferred availability zone lacks availability for your instance type, "backup" availability zones will be tried.	Insufficient capacity in AWS (i.e., AWS lacks availablility for your desired EC2 instance type in your preferred availability zone) Cost savings (i.e., You want to try launching your EC2 runner as a spot instance first)
validate-notebooks	Used to validate .ipynb files	I maintain a collection of .ipynb files and run ci jobs to test them. I would like to quickly verify that the files are formatted correctly before spinning up more complex or expensive CI jobs to test those notebooks.
update-constraints	Used to update constraints-dev.txt file	I pin all project dependencies in CI using constraints-dev.txt file. I would like to monitor new dependency releases and periodically post PRs to move pins forward.
inference-mock	Used to mock LLM calls	I have a notebook that I want to test that makes an LLM call, but I don't need to rely heavily on an LLM and don't need to run a real inference server for this test.

❓ How to Use One or More In-House GitHub Actions

Each GitHub action in this repository contains documentation explaining how to reference and use it in another repo.

📬 Contributing

Check out our contributing guide to learn how to contribute.