Skip to content

Automate Integration Testing in GitHub Actions CI Pipeline #760

@jordanpadams

Description

@jordanpadams

Are you sure this is not a new requirement or bug?

Yes

💡 Description

Registry API integration tests currently cannot run in GitHub Actions due to memory constraints on standard runners, and the local developer testing workflow lacks sufficient automation for reliable use. This theme covers the work needed to establish a robust, scalable CI/CD pipeline for integration testing — one that runs automatically on every PR, is reproducible locally, and remains viable as the test suite grows.

Sub-issues under this theme:

Acceptance Criteria

Given a developer submits or updates a PR on registry-api
When GitHub Actions runs
Then the integration test suite executes automatically and reports pass/fail as a PR status check

Given a developer wants to run integration tests locally
When they follow the documented setup
Then the same tests execute using branch-matched images, producing results consistent with CI

⚙️ Engineering Notes

The core challenge is that running the full stack (OpenSearch + registry-api + reg-loader + reg-sweepers + Newman) exceeds the memory available on standard GitHub-hosted runners. Solutions range from JVM tuning in docker-compose (free, low effort) to using GitHub larger runners or offloading OpenSearch to Amazon OpenSearch Serverless (AOSS). See issue #759 for detailed option analysis.

Branch-matching logic between registry-api and registry repos is a key design requirement: CI must automatically use the correct image versions for both repos when running tests.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    ToDo

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions