Artifacts [release]

When creating a new release (and corresponding Git tag), a tar.gz archive is generated and attached to that release. This archive contains all the key files required to represent the platform at that specific version, including:

platform-descriptor.json

A folder with application descriptors

package.json and yarn.lock (for dependency management)

stripes.config.js and stripes.modules.js

By packaging these files together, the release artifact fully captures the state of the platform‑lsp repository at the time of tagging, making it easy to share and deploy consistently.

Platform descriptor (example)

This platform-descriptor.json defines a FOLIO/Eureka “platform” by listing its essential metadata (name, description, version) along with all modules and services it requires. Under eureka-components, you see core infrastructure modules (e.g. Keycloak, Kong, manager, sidecar) with their versions. The applications section breaks down required vs. optional apps, and also declares key dependencies like PostgreSQL, Kafka or OpenSearch. Together, this descriptor provides a single source of truth for deploying or assembling the platform, ensuring each component is correctly versioned and included in the final environment.

platform-descriptor-graph

{
  "name": "Platform LSP",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
  "version": "1.0.0",
  "eureka-components": [
    {
      "name": "folio-kong",
      "version": "3.7.2"
    },
    {
      "name": "folio-keycloak",
      "version": "26.1.0"
    },
    {
      "name": "folio-module-sidecar",
      "version": "2.0.6"
    },
    {
      "name": "mgr-applications",
      "version": "2.0.3"
    },
    {
      "name": "mgr-tenants",
      "version": "2.0.1"
    },
    {
      "name": "mgr-tenant-entitlements",
      "version": "2.0.8"
    }
  ],
  "applications": {
    "required": [
      {
        "name": "app-platform-minimal",
        "version": "1.0.31"
      },
      {
        "name": "app-platform-complete",
        "version": "1.1.45"
      }
    ],
    "optional": [
      {
        "name": "app-erm-usage",
        "version": "1.0.3"
      },
      {
        "name": "app-edge-complete",
        "version": "1.0.7"
      },
      {
        "name": "app-dcb",
        "version": "1.0.7"
      },
      {
        "name": "app-consortia-manager",
        "version": "1.0.0"
      },
      {
        "name": "app-consortia",
        "version": "1.1.3"
      },
      {
        "name": "app-edge-locate",
        "version": "1.0.1"
      },
      {
        "name": "app-requests-mediated",
        "version": "1.1.2"
      },
      {
        "name": "app-requests-ecs",
        "version": "1.0.6"
      },
      {
        "name": "app-reading-room",
        "version": "1.0.0"
      },
      {
        "name": "app-requests-mediated-ui",
        "version": "1.0.1"
      }
    ]
  },
  "dependcies": {
    "postgres": ">=16.0",
    "kafka": ">=2.8.0",
    "opensearch": ">=1.0.0"
  }
}

Folio Development Teams

Artifacts [release]

Platform descriptor (example)

Related content