IAR Build Tools for Arm on GitLab with Linux runners

[!WARNING]
The information in this repository is subject to change without notice and does not constitute a commitment by IAR. While it serves as a valuable reference for DevOps Engineers implementing Continuous Integration with IAR Tools, IAR assumes no responsibility for any errors, omissions, or specific implementations.

Introduction

From a CI/CD perspective, the IAR Build Tools for Arm comes with everything you need to build embedded firmware projects from the command line. This tutorial provides a simple example with general guidelines on how to set up a CI/CD pipeline using GitLab CI while taking advantage of the so-called GitLab self-managed runners.

In case you need an introduction on how to get started with GitLab, use their Tutorials.

Prerequisites

Before you begin, you will need to download and install the following:

• IAR Build Tools for Arm 9.60.2 for Ubuntu 22.04 x64 (bxarm-9.60.2.deb)
  • IAR customers can download it directly from IAR MyPages. If you do not have a license, contact IAR Sales.

You also will need:

• A GitLab organization account
  • or a GitLab enterprise account.

[!NOTE]
This guide was based on the options available in GitLab v17.4.

Quickstart

Under your organization’s GitLab account:

• Go to Create New… → Import Project → Repository by URL.
• Fill Git repository URL with this repository’s URL.
• In the Project URL, Pick a group or namespace.
• Make sure the Visibility level is set to 🔘 Private.
• Finally click Create project.

Once the importing process is complete, a banner will show up with the message The project was successfully imported. and you will be taken to your imported repository.

A GitLab workflow example

On your private repository, navigate to the .gitlab-ci.yml workflow file. This file uses the GitLab-flavored YAML to describe a workflow containing multiple jobs typically used in embedded firmware projects.

Refer to the .gitlab-ci.yml workflow file for detailed comments.

Adding runners to your repository

It is straightforward to set up a self-managed GitLab runner in a Linux host with the IAR Build Tools for Arm for building your project on automated workflows:

• Navigate to your repository’s Settings → CI/CD (https://gitlab.com/<username>/bx-gitlab-ci/-/settings/ci_cd).
• Expand Runners.
• Disable - [ ] Instance Runners.
• In Project Runners, click New project runner.
• Create a new Tag for your runner. (e.g., self-hosted).
• Click Create runner.

Registering a GitLab Runner

You will be taken to the next page for registering a newly created runner.

• Select 🔘 Linux as the Operating System.
• This page also provides a link (“How do I install GitLab Runner?”). Install the GitLab Runner on the same host where you already have the IAR Build Tools for Arm pre-installed.
• Follow the remaining steps provided on the Register runner page.
• When asked for Entering an executor, type shell.
• Once “🎉 You’ve registered a new runner!”, click View runners.

You can have as many parallel build nodes with runners as your license allows you to. Contact IAR Sales for expanding your build capacity.

Summary

This tutorial provided an overview of how to get started with the IAR Build Tools for Arm on GitLab using self-managed Linux runners. Development teams can immediately benefit from the comprehensive feedback these modern workflows offer, enabling them to quickly build, analyze, test, and deploy with high quality.

Follow us on GitHub to get updates about tutorials like this and more.

Issues

For technical support contact IAR Customer Support.

For questions or suggestions related to this tutorial: try the wiki or check earlier issues. If those don’t help, create a new issue with detailed information.