How to Include a New Eureka Application in Snapshot Environment Builds

This guide covers the steps to include a newly developed Eureka application in the snapshot environment builds of the FOLIO platform.

Prerequisites

• The application app-* GitHub repository has been created following the How-To Create a New Application Repository guide.

• The repository is accessible, and Admin Access permission has been granted to the Kitfox team.

• All application backend modules have corresponding Helm charts.

• The repository follows the standard app-* layout described in Working with Application Repositories: application.template.json, pom.xml, .github/update-config.yml, CI workflows.

Application Repository Setup

Each Eureka application is managed through its own app-* repository. The CI system automatically resolves module versions (every 20 min), validates interfaces, and publishes application descriptors to the FOLIO Artifact Registry (FAR).

For the full workflow — template layout, version constraints, update configuration, and state files — refer to Working with Application Repositories.

Interface Dependencies

All checks and validation for interface(s) dependencies must be done: https://dev.folio.org/folio-api-dependencies/, if any of modules REQUIRES the interface(s) of the new Eureka application that you're working on, that means either additional changes are required inside moduleDescriptor(s) of that/those module(s): REQUIRES → OPTIONAL or creating an additional brand new Eureka application i.e. moving out that/those module(s) from the app-platform-complete to avoid this kind of issues/errors:

Determine the appropriate place for your application based on the application dependency, Application Composition Plan and its current state.

Steps to Include a Eureka Application

1. Create a Jira Ticket

• Navigate to the Rancher Jira project.

• Create a new Jira ticket requesting the inclusion of your application in the snapshot builds.

• Specify the repository link of the newly developed app-* application.

• If the application is meant to be added to environments on demand (like app-marc-migrations), please explicitly provide this information in the ticket.

2. Grant Access to the Kitfox Team

Make sure the Kitfox team has the necessary permissions to access and commit to your application's repository.

3. Notify the Kitfox Team

• Inform the Kitfox team via the Rancher support Slack channel.

• Share the Jira ticket link and give a brief description of your application.

Further Information

• Your application should be listed here: FOLIO Eureka Applications.

• For the complete app-* repository workflow, see Working with Application Repositories.

• For detailed guidelines on ongoing application maintenance and best practices, refer to Application Management and Releases.

Support

Contact the Kitfox team directly via Slack for immediate assistance or raise issues through the Jira ticketing system.