Skip to main content

GitHub Actions Example Using a GitHub Runner

GitHub Actions are a great way to automate, customize, and execute your software development workflows right in your repository.

To follow this tutorial, you will need:


  1. Create an empty GitHub repository for your runner to accept jobs from by following the steps in this GitHub Article.


  1. Add an "API_TOKEN" secret to your repository with a value of your API Token by following the steps in this GitHub Article.

API token example

  1. Create a .github/workflows directory in your repository, then create a file named github-actions-demo.yml inside the .github/workflows directory.

  2. Copy the Demo File contents below and paste them into the github-actions-demo.yml file.

name: Simpledemo
on: [workflow_dispatch]
runs-on: ubuntu-latest
- name: Check out source code
uses: actions/checkout@v1

- name: Install Corellium Api
run: npm install @corellium/corellium-api

- name: Run example
run: node main.js
  1. Clone the device_example folder from into the repository you just made.

  2. In your repository, click Actions.

Action Menu

  1. Click the workflow you would like to run on the left, then click Run workflow

name of the workflow

  1. Select Run workflow. The workflow should appear and begin running.

run workflow

  1. Click on the name of the workflow to see the jobs.

click workflow

  1. Click the name of the job to see the steps.

name of the job

  1. Now, you can expand each step to see the output.


Next Steps

Check out our article on the Simple API Example article we used in this GitHub actions demo for information on how to configure it to run on your Corellium account.