Skip to content

Commit 5039f2a

Browse files
Merge pull request #1846 from jasonrandrews/review
Tech review of GitHub Arm-hosted runners.
2 parents 2403de5 + 0302b0a commit 5039f2a

File tree

4 files changed

+42
-22
lines changed

4 files changed

+42
-22
lines changed

content/learning-paths/laptops-and-desktops/gh-arm-runners-win/_index.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
title: Automate Windows on Arm Builds with GitHub Arm-hosted Runners
33

4+
draft: true
5+
cascade:
6+
draft: true
7+
48
minutes_to_complete: 20
59

610
who_is_this_for: This is an introductory tutorial for software developers interested in automating Windows application builds on Arm architecture using GitHub Actions.
@@ -11,14 +15,14 @@ learning_objectives:
1115
- Automate the build process of Windows applications using GitHub Actions.
1216

1317
prerequisites:
14-
- A GitHub account
15-
- Basic knowledge of GitHub Actions
18+
- A GitHub account.
19+
- Basic knowledge of GitHub Actions.
1620

1721
author:
1822
- Pareena Verma
1923

2024
### Tags
21-
skilllevels: Introducory
25+
skilllevels: Introductory
2226
subjects: CI-CD
2327
armips:
2428
- Cortex-A

content/learning-paths/laptops-and-desktops/gh-arm-runners-win/automate-win-app.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A basic overview of the application is provided here but for details on building
1515
The source code for the application that renders a rotating 3D cube to perform the calculations using different programming options is provided in this GitHub repository.
1616

1717
```console
18-
https://github.com/odincodeshen/SpinTheCubeInGDI.git
18+
https://github.com/arm/SpinTheCubeInGDI
1919
```
2020

2121
The application implements a spinning cube and consists of four key components:
@@ -26,21 +26,21 @@ The application implements a spinning cube and consists of four key components:
2626

2727
The code has two options to calculate the rotation:
2828

29-
1. Multithreading: the application utilizes multithreading to improve performance by distributing the rotation calculations across multiple threads.
30-
2. Arm Performance Libraries: the application utilizes optimized math library functions for the rotation calculations.
29+
1. Multithreading: the application uses multithreading to improve performance by distributing the rotation calculations across multiple threads.
30+
2. Arm Performance Libraries: the application uses optimized math library functions for the rotation calculations.
3131

32-
You will learn how to automate the build process for this application by using GitHub Actions that leverages the Arm-hosted Windows runners.
32+
You will learn how to automate the build process for this application by using GitHub Actions with Arm-hosted Windows runners.
3333

3434
### Automate the Build Process
3535

36-
This GitHub Actions workflow [`msbuild.yml`](https://github.com/odincodeshen/SpinTheCubeInGDI/blob/main/.github/workflows/msbuild.yml) that automates the build process for this project using MSBuild for Windows on Arm is included in this repository.
36+
The [GitHub Actions workflow `msbuild.yml`](https://github.com/arm/SpinTheCubeInGDI/blob/main/.github/workflows/msbuild.yml) that automates the build process using MSBuild for Windows on Arm is included in the repository.
3737

3838
Below is an explanation of the steps in the workflow:
3939

4040

41-
**Trigger Events**: The workflow runs when there is a push or pull_request event on the main branch.
41+
**Trigger Events**: The workflow runs when there is a push or pull request event on the main branch.
4242

43-
**Job Definition**: A single job named build is defined. It runs on the GitHub Arm-hosted Windows runner (`windows-11-arm`) as shown:
43+
**Job Definition**: A single job named `build` is defined. It runs on the GitHub Arm-hosted Windows runner (`windows-11-arm`) as shown:
4444

4545
```console
4646
jobs:
@@ -65,7 +65,17 @@ jobs:
6565

6666
**Upload Build Artifact**: Uploads the built executable as an artifact using `actions/upload-artifact@v4`.
6767

68-
This workflow automates the process of dependency management, environment setup, building your Windows on Arm project, and storing the final artifact all using GitHub Arm-hosted runner. You can view the `Actions` logs on the repository for each step.
68+
This workflow automates the process of dependency management, environment setup, building the project, and storing the final artifact all using a GitHub Arm-hosted Windows runner.
69+
70+
### Fork the repository and run the workflow
71+
72+
To run the workflow, you can fork the repository and run the workflow in your GitHub account.
73+
74+
To fork the repository, go to the repository page on GitHub and click the `Fork` button in the top right corner. This will create a copy of the repository under your own GitHub account.
75+
76+
You can then run the workflow in your forked repository by navigating to the `Actions` tab and selecting the MSBuild workflow, then clicking `Run workflow`.
77+
78+
You can view the `Actions` logs in the repository for each step.
6979
![action #center](_images/actions.png)
7080

71-
You have successfully built your Windows application and uploaded the application as an artifact of your workflow using the GitHub Arm-hosted Windows runner.
81+
You have learned how to build a Windows application and upload the result as an artifact of your workflow using the GitHub Arm-hosted Windows runner.

content/learning-paths/laptops-and-desktops/gh-arm-runners-win/introduction.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 2
66
### FIXED, DO NOT MODIFY
77
layout: learningpathall
88
---
9-
GitHub Arm-hosted runners for Windows are now available in public preview, providing a powerful and efficient way to build, test and deploy your Windows applications on Arm without the need for virtualization. These runners come with a Windows 11 Desktop image, equipped with many tools to get started with your workflows.
9+
GitHub Arm-hosted runners for Windows are now available in public preview, providing a powerful and efficient way to build, test, and deploy your Windows applications on Arm without the need for virtualization. These runners come with a Windows 11 Desktop image, equipped with many tools to get started with your workflows.
1010

1111
### What are GitHub Arm-hosted Runners?
1212

@@ -16,17 +16,22 @@ Arm-hosted runners are available for public repositories at no cost, subject to
1616

1717
### How to use GitHub Arm-hosted Windows Runners?
1818

19-
To leverage the GitHub Windows Arm64 hosted runners, you will need to use the following label in your public repository workflow runs:
19+
To leverage the GitHub Windows Arm64 hosted runners, you need to use the following label in your public repository workflow runs:
2020

2121
```yaml
2222
runs-on: windows-11-arm
2323
```
2424
25-
Please note that this label will not work in private repositories, the workflow will fail if you add it.
25+
{{% notice Note %}}
26+
This label will not work in private repositories, the workflow will fail if you use it.
27+
{{% /notice %}}
2628
27-
Two types of GitHub-hosted runners are available; standard runners, and larger runners. Larger runners are differentiated from standard runners because users can control the amount of RAM, the number of CPUs, and configure the allocated disk space. You can also use the Windows 11 Desktop Arm Image with larger runners. To use this image on large runners, you will need to create a new runner.
2829
29-
### How can I create an GitHub Arm-hosted Windows large runner?
30+
### What types of GitHub-hosted runners are available?
31+
32+
Two types of GitHub-hosted runners are available; standard runners and larger runners. Larger runners are differentiated from standard runners because you can control the amount of RAM, the number of CPUs, and configure the allocated disk space. You can also use the Windows 11 Desktop Arm Image with larger runners. To use this image on larger runners, you will need to create a new runner.
33+
34+
### How can I create an GitHub Arm-hosted Windows larger runner?
3035
3136
Arm-hosted runners are created at the organization level.
3237
@@ -36,7 +41,6 @@ On the `Runners` page, select the `New runner` drop-down on the top right, and t
3641

3742
![new-runner #center](_images/new-runner.png)
3843

39-
4044
Specify a name for the runner, this is the `runs-on` field in your workflows so make the name clear for others who use it.
4145

4246
Choose Windows ARM64 for the platform and click `Save`.
@@ -47,7 +51,7 @@ Specify the operating system image for the runner, select `Microsoft Windows 11
4751

4852
![image #center](_images/win_image.png)
4953

50-
Select the size of the large runner you need and and click `Save`.
54+
Select the size of the larger runner you need and click `Save`.
5155

5256
![specifications #center](_images/size.png)
5357

@@ -59,17 +63,18 @@ You can also set the runner group for this runner. The runner group controls the
5963

6064
Finally, click `Create runner`.
6165

62-
Your new Arm-hosted runner Windows large runner is ready to use. You will need to remember the runner name for use in your workflows with the `runs-on` label.
66+
Your new Arm-hosted Windows larger runner is ready to use. Remember the runner name so you can use it in your workflows with the `runs-on` label.
67+
68+
### How do I check the server hardware used by the Arm-hosted Windows Runners?
6369

64-
### Check the server hardware used by the Arm-hosted Windows Runners
6570
The Arm-hosted runners are powered by Microsoft Azure Cobalt 100 processors, based on the Arm Neoverse N2, with 4 vCPUs and Armv9-A features, including Scalable Vector Extension 2 (SVE2).
6671

6772
The output from running the `wmic` command on the Arm-hosted runner is below.
6873

6974
![Arm-hosted runner info #center](_images/cpuinfo.png)
7075

7176

72-
### Check Installed Software on the Arm-hosted Windows Runners
77+
### How can I find the software installed on the Arm-hosted Windows Runners?
7378

7479
To find out more about the software installed on the Arm-hosted runners, visit the [GitHub Actions Partner Images repository](https://github.com/actions/partner-runner-images/). Check the [image documentation](https://github.com/actions/partner-runner-images/blob/main/images/arm-windows-11-image.md) for a list of software packages installed on the Windows 11 by Arm Limited image. You can also use this repository to report issues or request additional software.
7580

content/learning-paths/laptops-and-desktops/windows_armpl/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ tools_software_languages:
2323
- Visual Studio
2424
- C#
2525
- .NET
26+
- Arm Performance Libraries
2627
operatingsystems:
2728
- Windows
2829

0 commit comments

Comments
 (0)