<div id="readability-page-1" class="page"><div id="main" role="main">
 <article>
 <div>
 
 
 <blockquote>
 Usage and example of github actions matrix
</blockquote>



<h2 id="environment-and-prerequisite">Environment and Prerequisite</h2>

<ul>
 <li>Github Actions</li>
</ul>



<h2 id="background">Background</h2>

<ul>
 <li>I needed to execute CI/CD with the same tasks but by changing only a few values, so I applied it.</li>
 <li>Detailed usage and examples can be found at <a href="https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-jobs">https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-jobs</a>.</li>
</ul>



<h2 id="usage">Usage</h2>

<ul>
 <li>According to the document, you can use it as shown below.</li>
 <li><code>jobs.&lt;job_id&gt;.strategy.matrix</code> is where you define the variables and values for the matrix.</li>
 <li>In the example below, the values corresponding to <code>version</code> are <code>[10, 12, 14]</code> and the same applies to <code>os</code>.</li>
</ul>

<div><pre><code>jobs:
 example_matrix:
 strategy:
 matrix:
 version: [10, 12, 14]
 os: [ubuntu-latest, windows-latest]
</code></pre></div>



<h2 id="example">Example</h2>

If you want to run Jekyll builds on multiple OS, you can write it as shown below. This is a workflow example actually used in this blog.

<h3 id="code">Code</h3>

<ul>
 <li>This include other steps but just look on <code>strategy</code> in <code>jobs</code>’s <code>build</code>.</li>
 <li>Define os on statement <code>os: [ubuntu-22.04, ubuntu-20.04, macos-latest]</code> and use it on <code>runs-on: ${{ matrix.os }}</code>.</li>
</ul>

<div><pre><code>name: Jekyll Build CI

on:
 push:
 branches: [ main ]
 pull_request:
 branches: [ main ]
 workflow_dispatch:
 inputs:
 ruby-version:
 required: true
 type: string
 default: "3.2.2"
 
jobs:
 build:
 name: jekyll build
 strategy:
 matrix:
 os: [ubuntu-22.04, ubuntu-20.04, macos-latest]
 fail-fast: false
 runs-on: ${{ matrix.os }}
 steps:
 - name: Checkout Repository
 uses: actions/checkout@v4
 - name: Setup Ruby
 uses: ruby/setup-ruby@v1
 with:
 ruby-version: ${{ github.event.inputs.ruby-version }}
 - name: Install Bundler
 run: |
 gem install bundler
 - name: Install Dependencies
 run: |
 bundle install
 - name: Build Jekyll Site
 run: |
 bundle exec jekyll build
</code></pre></div>

<h3 id="result">Result</h3>

<ul>
 <li>To make it easier to understand, I’m attaching an image that shows the results of the execution.</li>
</ul>

<img src="https://twpower.github.io/images/20240811_355/build-result-screenshot.png">




<h2 id="reference">Reference</h2>

<ul>
 <li><a href="https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-jobs">https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-jobs</a></li>
</ul>

 
 
 
 </div>
 
 
 

 </article>
</div></div>

TWpower’s Tech Blog

Usage and example of github actions matrix
Environment and Prerequisite
Github Actions
Background
I needed to execute CI/CD with the same tasks but by changing only a few values, so I applied it.
Detailed usage and examples can be found at https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-jobs.
Usage
According to the document, you can use it as shown below.
jobs.<job_id>.strategy.matrix is where you define the variables and values for the matrix.
In the example below, the values corresponding to version are [10, 12, 14] and the same applies to os.
jobs:
 example_matrix:
 strategy:
 matrix:
 version: [10, 12, 14]
 os: [ubuntu-latest, windows-latest]
Example
If you want to run Jekyll builds on multiple OS, you can write it as shown below. This is a workflow example actually used in this blog.
Code
This include other steps but just look on strategy in jobs’s build.
Define os on statement os: [ubuntu-22.04, ubuntu-20.04, macos-latest] and use it on runs-on: ${{ matrix.os }}.
name: Jekyll Build CI
on:
 push:
 branches: [ main ]
 pull_request:
 branches: [ main ]
 workflow_dispatch:
 inputs:
 ruby-version:
 required: true
 type: string
 default: "3.2.2"
 
jobs:
 build:
 name: jekyll build
 strategy:
 matrix:
 os: [ubuntu-22.04, ubuntu-20.04, macos-latest]
 fail-fast: false
 runs-on: ${{ matrix.os }}
 steps:
 - name: Checkout Repository
 uses: actions/checkout@v4
 - name: Setup Ruby
 uses: ruby/setup-ruby@v1
 with:
 ruby-version: ${{ github.event.inputs.ruby-version }}
 - name: Install Bundler
 run: |
 gem install bundler
 - name: Install Dependencies
 run: |
 bundle install
 - name: Build Jekyll Site
 run: |
 bundle exec jekyll build
Result
To make it easier to understand, I’m attaching an image that shows the results of the execution.
Reference
https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-jobs

[CI/CD](EN) Usage and example of github actions matrix

댓글