Action that could be used to test projects that use O3DE-Extras

This action will build and publish the container image containing O3DE-extras to the dockerhub and the reuse this image to build and run your custom tests.

The container is called ci-o3de-extras:latest and could be found TODO: add link to the dockerhub.

Versions: OS: Ubuntu Jammy O3DE: 2305 O3DE-Extras: 2305.0 ROS2: humble NodeJs: 16

SECRETS: DOCKER_HUB_USERNAME DOCKER_HUB_PASSWORD

Github large runner or self-hosted runner is required to run this action. (The container is too big for the regular runner, ~32GB)

Requirements

Test script. This action allows to execute your custom tests inside the container. Remember that the script should be executable (chmod +x).

Example of the test script:

#!/bin/bash

# Expected result
VALUE="RESULT: ALL TESTS PASSED"

# Print the value
echo $VALUE

exit 0

Expected result form the test script is RESULT: ALL TESTS PASSED. If the result is different the action will fail.

Create an workflow that uses this action

name: TEST - Build with O3DE Extras

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - '*'

jobs:
  build:
    runs-on: self-hosted

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Set up O3DE Extras
        uses: robotec.ai/setup-o3de-extras@0.1
        with:
          script-path: test/script.sh

Modifying the action

Modify the action by editing action.yml and src/main.ts.
Install the dependencies

npm install

Build the typescript and package it for distribution

npm run build && npm run package

Run the tests ✔️

npm test # this will run the `__tests__/main.test.js` using Jest

To add files from different paths modify the tsconfig.build.json file.

Change action.yml

The action.yml defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the documentation

Publish

To publish a new version: