Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 6.3 KB

README.md

File metadata and controls

90 lines (61 loc) · 6.3 KB

GitHub Actions Partner Runner Images

Table of Contents

About

This repository contains the information about the VM images provided by GitHub partners which can be used on GitHub-hosted larger runners.

Partner images are VM images which are created by third parties which GitHub Hosted Action runner customers can use to improve particular use cases in their workflow by providing particular tools in 'one click' to work with.

Available Images

Partner Image YAML Label Included Software OS / Architecture Rollout Progress of Latest Image Release Support Link
Arm Limited, Inc. Ubuntu 24.04 by Arm Limited custom in larger runners Ubuntu 24.04 Inventory Linux, ARM64 In Beta (Public) About & Support
Arm Limited, Inc. Ubuntu 22.04 by Arm Limited custom in larger runners Ubuntu 22.04 Inventory Linux, ARM64 In Beta (Public) About & Support
Arm Limited, Inc. ARM-Partner-AVH custom in larger runners AVH Inventory Linux, x64 In Beta (Private) About & Support

Current Partner image overview

Ubuntu 24.04 by Arm Limited

The image has the most popular tools pre-installed. Check the image documentation for more details. It is a recommended image to use with Linux Arm64 Runners.

Ubuntu 22.04 by Arm Limited

The image has the most popular tools pre-installed. Check the image documentation for more details. It is a recommended image to use with Linux Arm64 Runners.

Blogs

Arm Virtual Hardware (AVH) images contain ready-to-use Arm Cortex-M simulation models and Compiler toolchains for native use with GitHub Actions. This image is for customers who have ARM edge IoT use cases and workloads that they would like to build and test through GitHub Actions. The types of customers will be those working in industries like Medical devices, Agriculture, Consumer electronics, automotive, etc.

Image Definitions

Beta

The purpose of a Beta is to collect feedback on an image before it is released to GA. The goal of a Beta is to identify and fix any potential issues that exist on that image. Images are updated on a cadence owned by the third party who provided the image, please see the image information above. Any workflows that run on a beta image do not fall under the customer SLA in place for Actions. Customers choosing to use Beta images are encouraged to provide feedback in the partner-runner-images repo by creating an issue. A Beta may take on different availability, i.e. public vs private.

GA

A GA (General Availability) image has been through a Beta period and is deemed ready for general use. Images are updated on a weekly cadence. In order to be moved to GA the image must meet the following criteria:

  1. Has been through a Beta period (public or private)
  2. Most major software we install on the image has a compatible version for the underlying OS
  3. All major bugs reported during the Beta period have been addressed

Any workflows that run on a partner image do not fall under the customer SLA as GitHub cannot commit to the partner updating the image within these timeframes.

Software and Image Support

Support Policy

  • Updates to each image are owned and managed by the partner providing the image, not GitHub
  • GitHub makes no warranties or guarantees for the images or their contents
  • Each partner image will have a different term of support depending on the partner, partner support links can be found below

How to Interact with the Repo

  • Issues: To file a bug report, or request tools to be added/updated, please open an issue using the appropriate template
  • Discussions: If you want to share your thoughts about image configuration, installed software, or bring a new idea, please create a new topic in a discussion for a corresponding category. Before making a new discussion please make sure no similar topics were created earlier.
  • For general questions about using the runner images or writing your Actions workflow, please open requests in the GitHub Actions Community Forum.

FAQs

How does GitHub determine which partners are able to provide images?

We are currently reviewing which partnerships are best suited to provide particular experiences in GitHub Actions. If you are interested in providing an image please create an issue in this repo and the GitHub team will reach out to you.

How do I request that a new tool be pre-installed on a particular image? Please create an issue and get an approval from us to add this tool to the image before creating the pull request.