Dependencies

TOC

• Introduction
• Uses
• Syntax used
  • Versions constraints syntax
  • Semantic versioning
• Dependencies list
  • Other dependencies relevant only for the LA Community
• End

Introduction

This is a simple list of LA components, dependencies and version constraints.

This page specify version numbers and version constraints in a similar way that pub.dev and other software packages do.

Uses

This list can be used as documentation to give some recommendations during LA portal upgrades.

But this information is also specially useful as a source for software or packaging dependencies specification. Some screenshots from the la-toolkit:

Syntax used

The structure of this list is like this:

• some-module-name (version constraint): dependency (version constraint), another-dependency (version constraint), ...
• some-module-name (other version constraint): dependency (other version constraint)

Versions constraints syntax

• any: any version.
• ^ followed by a version string. Versions compatible with the version. Example: ^1.0.0 allows any version from 1.0.0 to 2.0.0 (but not including 2.0.0).
• a series of version parts. Each part can be one of:
  • A version string like 1.2.3.
  • A comparison operator (<, >, <=, or >=) followed by a version string.

Samples of versions:

• any
• ^0.7.2
• ^1.0.0
• 1.2.3-SNAPSHOT
• <= 5.1.4
• > 2.0.4 <= 2.4.6

Semantic versioning

Please try to use semantic versioning https://semver.org/ in future LA releases. So these are valid versions:

• 1.0.0
• 0.1.0-SNAPSHOT

but these are invalid:

• 1.0
• 0.1-SNAPSHOT
• 1.0.1.1

Dependencies list

This is the alphabetical list of known recommended dependencies:

• ala-install (>= 2.0.3): ansible (2.10.3) ↗
• alerts (>= 1.5.1): regions (>= 3.3.5), biocache-hub (>= 3.2.9), bie-hub (>= 1.5.0) ↗
• biocache-service (>= 2.5.0): tomcat (>= 9)
• biocache-service (>= 2.7.0): biocache-store (>= 2.6.1) ↗
• biocache-store (any): biocache-service (< 3.0.0)
• biocache-store (>= 2.4.5): image-service (>= 1.0.7) ↗
• doi (>= 1.1): biocache-service (>= 2.5.0), regions (>= 3.3.4) ↗
• image-service (>= 1.1): ala-install (>= 2.0.8) ↗
• pipelines (any): biocache-service (>= 3.0.0)
• pipelines (any): ala-install (here the version where this PR is merged)
• spatial-hub (0.3.12): spatial-service (> 0.3.12) ↗
• (...)

Other dependencies relevant only for the LA Community

This is a list of dependencies only relevant for the LA Community for some reason (for instance, because the code is adapted to be used by the LA community outside Australia).

• dashboard (>= 2.2): ala-install (>= 2.0.5) ↗
• (...)

Feel free to edit and improve this page!