TS-Keyword

Welcome to the Arm Laboratory repository where we are demonstrating using the Arm Total-Solution Keyword detection software in the Open-IoT-SDK project to utilize the GitHub Custom Runner feature. This repository can be used as a template to create your own CI system within GitHub. Go ahead and fork this repository to your own GitHub account and replace the actions with your own. See below for more information on how it all works.

There are 2 ways to trigger the runner workflow, via a code change or manually starting the workflow.

Manual workflow execution

If you simply want to execute the runner workflow configured in this repository, you can take advantage of the workflow_dispatch option via the Actions page. See the steps below.

1. In a new browser window, open the TS-Keyword Actions link.
2. Select the simple-ci-112 entry on the left, you will then see a row that looks like this:

   This workflow has a workflow_dispatch event trigger. . . Run Workflow

3. Click on the Run Workflow button on the right.
   • In the drop down menu choose Run Workflow

Skip down to the Runner observation instructions below.

Code change execution

To experiment with a normal developer flow and take GitHub Custom runner feature for a spin, clone the repository, modify a file and push those changes back to the repository, automatically starting a Continous-Integration (CI) process.

It is expected at this stage that you have forked this repository and you are working within your own project.

1. Clone the repository

   git clone https://github.com/Arm-Labs/TS-Keyword.git; cd TS-Keyword

2. Edit a file

    vi README.md

3. Use git commands to add, create a commit message, and then push to the repo.

    git add README.md

    git commit -m "Simple update"

    git push origin main

Skip down to the Runner observation instructions below.

Runner observation

Follow the instructions below to find your runner action. We use the address of this repository for educational purposes only. Replace the location with your own project for actual execution.

1. In the browser showing the TS-Keyword repository page:
   • click on Actions or Click on this link TS-Keyword Actions.
   • You should see your run using the commit message that you entered above or if you manually started the workflow you will see the name of the workflow at the top: simple-ci-112.
   • Click on the hyperlinked message/name to go to the workflow run.
2. On the specific runs page, click on the workflow name in the box, ci_build_and_test_ats_keyword_112
   • This next page will show you all the steps that make up this workflow.
   • You can expand each one to see the results of that step.
3. The results of the run will be shown on the action screen with a Green checkmark or a Red X.