This is a GitHub action that allows you to utilize Kobiton automation testing, which makes it convenient for running auto script with many custom values like which executor will be used to perform, which device we need to take action or the repository of the test script

1. Getting Started
   • Setup workflow and action
   • Setup secrets for private items
2. Input Variables
3. Test Result
4. Some Notes
5. License

To get started using the action for your project, create a folder called .github and inside it, create another folder called workflows. Finally inside the workflows folder, create a file called main.yml or any name with the following contents:

.github/workflows/main.yml

on:
  push:
    branches:
      - main

jobs:
  run-test:
    runs-on: ubuntu-latest
    name: Input name for the job
    steps:
      - uses: actions/checkout@v3
      - uses: kobiton/execute-appium-test-github-action@<<version>>
        with:
          kobi_username: ${{ secrets.KOBI_USERNAME }}
          kobi_api_key: ${{ secrets.KOBI_API_KEY }}
          executor_url: https://example.com # get this from our support team
          executor_username: ${{ secrets.EXECUTOR_USERNAME }} # get this from our support team
          executor_password: ${{ secrets.EXECUTOR_PASSWORD }} # get this from our support team
          git_repo_url: https://github.com/sonhmle/azure-devops-sample-java-prod.git
          git_repo_branch: master
          git_repo_ssh_key: ${{ secrets.GIT_REPO_SSH_KEY }}
          app_id: kobiton-store:91041
          use_custom_device: 'true'
          device_name: 'Galaxy A20s'
          device_platform_version: '10'
          device_platform: 'Android'
          root_directory: '/'
          command: 'mvn test'
          wait_for_execution: 'true'

For more info about how to customize a workflow, check out the GitHub Actions documentation for workflow. You can trigger the action on many other kinds of event.

Kobiton Username and API key are required for authenticating with Kobiton API.

If you don't have a Kobiton account, visit https://portal.kobiton.com/register to create one.

To get your Kobiton Username and API Key, follow instructions at IV. Configure Test Script for Kobiton section on our blog.

In your Repo, go to Settings -> Secrets/Actions and click on "New repository secret". Then enter KOBI_USERNAME as the name and paste the suitable value. The same process is followed for KOBI_API_KEY, EXECUTOR_USERNAME, EXECUTOR_PASSWORD, GIT_REPO_SSH_KEY.

For more info about how to setup kinds of secrets, check out the GitHub Actions documentation for secrets

You can now push your project to GitHub and it will be automatically triggered the action.

Success, right? You learn more about GitHub Actions here

The action comes with additional options that you can use to configure the workflow. You can setup these values inside the "with" object as presented above:

The test result will be shown on GitLab console with report link, and the session will be listed in Kobiton Portal as mentioned above.

Your test session can be viewed on Kobiton website. Follow these steps below

1. Go to https://portal.kobiton.com/sessions, login with your Kobiton account.

2. You will see your executed sessions and their statuses.

3. Click on any session to view its details, commands.

• You can find the secrets tab in your project's settings

• If you're using the above exact workflow code, keep in mind that it deploys whenever you make a change to the main branch (Even README updates which have nothing to do with application code) and that might not be very efficient for you, have a look through the GitHub Actions documents to customize when the action should trigger.

• When you face any issues with the action, feel free to open an issue for our GitHub repository

This project is licensed for the MIT License here.