> OctoPerf load testing - How to integrate OctoPerf into Github Actions.
Source: https://api.octoperf.com/doc/runtime/edit-scenario/integrations-automation/ci-cd/ci/github-actions/
# Github Actions
[Github Actions](https://github.com/features/actions) is a tool to automatically build your software through continuous deployment. Github Actions is nothing else than an command-line runner built which runs your own scripts inside [Docker](https://docker.com) containers.
OctoPerf seamlessly integrates with Github Actions thanks to our [Maven Plugin](https://github.com/OctoPerf/octoperf-maven-plugin). You can run OctoPerf load tests as part of your software builds like:
- Run an existing scenario,
- Import and run a [JMeter JMX](https://jmeter.apache.org) stored in your git repository,
- Or even stop the build automatically whenever a [threshold or SLA](https://api.octoperf.com/doc/monitoring/create-connection/sla/) exceeds a certain criticality (Example: `WARNING`).
## Setup
### Prerequisites
In order to setup gitlab builds to run OctoPerf load tests, first you need:
- A [GitHub](https://github.com/) account,
- And an [OctoPerf](https://api.octoperf.com/) account.
### Introduction
First, you need to:
- Create a Github account,
- Then create a new repository named `octoperf-github-actions`.
Next, you will need an [OctoPerf Account](https://api.octoperf.com/). Now, let's setup a dummy project:
- Create a new project named `GitHub` in your `Default` workspace,
- Import the sample JMX. This should create an `httpbin.org` virtual user,
- Create a [Scenario](https://api.octoperf.com/doc/runtime/) named `Scenario` and configure the load settings for the `httpbin.org` user.
Now, it's time to save your API key for further use:
- Click in the top-right corner in OctoPerf UI and choose `Profile` in the menu,
- Copy the API Key.
Let's setup the gitlab repository now.
### Github Repository
Github Actions natively supports [running Maven](https://gitlab.com/gitlab-org/gitlab/-/blob/53ed9de852c2be69db23a0c0a64721f8bf7fba72/doc/ci/examples/artifactory_and_gitlab/index.md) builds:
- First, clone the github repository on your local machine:
```bash
git clone git@gitlab.com:username/octoperf-github-actions.git
```
- Then, you should create the maven `pom.xml` config file which contains:
```xml
4.0.0
pom
com.octoperf
octoperf-test
1.0.0-SNAPSHOT
com.octoperf
octoperf-maven-plugin
2.4.0
YOUR_API_KEY
Default
GitHub
Scenario
octoperf-releases
OctoPerf Releases
https://github.com/octoperf/maven-repository/raw/master/releases
octoperf-snapshots
OctoPerf Snapshots
https://github.com/octoperf/maven-repository/raw/master/snapshots
```
Make sure to replace `YOUR_API_KEY` by your account API Key.
- Then create a Github Action using maven to execute a scenario configured in your maven `pom.xml`:
Here is a sample github actions yml using maven to execute octoperf maven plugin:
```yml
# For more information on how to use our maven plugin, see:
# https://github.com/OctoPerf/octoperf-maven-plugin
name: OctoPerf Test using Github Actions
# Trigger an OctoPerf load test
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
cache: maven
- name: Build with Maven
run: mvn octoperf:execute-scenario --file pom.xml
```
This will execute an existing scenario named `Scenario`, expected to be in your account `GitHub` project and `Default` workspace.
- Commit those changes to your repository:
```bash
git add -A && git commit && git push
```
Which will push the 2 files to your git repository:
```bash
[master (root-commit) 8d8794b] OctoPerf Load Test
2 files changed, 51 insertions(+)
create mode 100644 .github/workflows/maven.yml
create mode 100644 pom.xml
Enumerating objects: 4, done.
Counting objects: 100% (4/4), done.
Delta compression using up to 12 threads
Compressing objects: 100% (4/4), done.
Writing objects: 100% (4/4), 894 bytes | 894.00 KiB/s, done.
Total 4 (delta 0), reused 0 (delta 0)
To github.com:jloisel/octoperf-github-actions.git
* [new branch] master -> master
```
- The CI Job should now be visible on Github Actions,
Congratulations! You've just triggered a load test on OctoPerf using **GitHub CI** and **OctoPerf Maven Plugin**.
The analysis report is visible in OctoPerf too. For further information, see our [OctoPerf Maven Plugin](https://github.com/OctoPerf/octoperf-maven-plugin) documentation.