Compatibility Rules
All the components are versioned with three parts (X.Y.Z) and share a common prefix: X is the ARLAS Exploration Stack version. It's driven by changes performed to backend APIs.
Backend
ARLAS-server
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes including ARLAS-server API |
| Y | Elasticsearch major version |
Indicates which major version of Elasticsearch ARLAS-server is compliant with |
| Z | ARLAS-server implementation version |
Incremented as soon as the ARLAS-server implementation receives a fix or an enhancement |
Info
3 clients of the API are generated
- arlas-api X.0.Z for Typescript
- arlas-api X.0.Z for Python
- arlas-server-client X.Y.Z for Java
ARLAS-persistence
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes including ARLAS-persistence API |
| 0 | - | Always set to 0 |
| Z | ARLAS-persistence implementation version |
Incremented as soon as the ARLAS-persistence implementation receives a fix or an enhancement |
Info
2 clients of the API are generated
- arlas-persistence-api X.0.Z for Typescript
- arlas-persistence-api X.0.Z for Python
ARLAS-tagger
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes including ARLAS-tagger API |
| Y | Elasticsearch major version |
Indicates which major version of Elasticsearch ARLAS-server is compliant with |
| Z | ARLAS-tagger implementation version |
Incremented as soon as the ARLAS-tagger implementation receives a fix or an enhancement |
Info
2 clients of the API are generated
- arlas-tagger-api X.0.Z for Typescript
- arlas-tagger-api X.0.Z for Python
Frontend
ARLAS-wui
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes |
| Y | ARLAS front libraries version |
Incremented as soon as one of the ARLAS front libraries receives a modification of the Angular Inputs/Outputs or a modification of a Typescript interface or class |
| Z | ARLAS-wui implementation version |
Incremented as soon as the ARLAS-wui implementation receives a fix or an enhancement |
Info
ARLAS-wui X.Y.Z fetches ARLAS-wui-toolkit X.Y.*
ARLAS-wui-builder
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes |
| Y | ARLAS front libraries version |
Incremented as soon as one of the ARLAS front libraries receives a modification of the Angular Inputs/Outputs or a modification of a Typescript interface or class |
| Z | ARLAS-wui-builder implementation version |
Incremented as soon as the ARLAS-wui-builder implementation receives a fix or an enhancement |
Info
ARLAS-wui-builder X.Y.Z fetches ARLAS-wui-toolkit X.Y.*
ARLAS-hub
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes |
| Y | ARLAS front libraries version |
Incremented as soon as one of the ARLAS front libraries receives a modification of the Angular Inputs/Outputs or a modification of a Typescript interface or class |
| Z | ARLAS-hub implementation version |
Incremented as soon as the ARLAS-hub implementation receives a fix or an enhancement |
Info
ARLAS-hub X.Y.Z fetches ARLAS-wui-toolkit X.Y.*
ARLAS-wui-toolkit
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes |
| Y | ARLAS front libraries version |
Incremented as soon as one of the ARLAS front libraries receives a modification of the Angular Inputs/Outputs or a modification of a Typescript interface or class |
| Z | ARLAS-wui-toolkit implementation version |
Incremented as soon as the ARLAS-wui-toolkit implementation receives a fix |
Info
ARLAS-wui-toolkit X.Y.Z fetches ARLAS-web-components X.Y.* , ARLAS-web-contributors X.Y.*, arlas-persistence-api X.0.* and arlas-tagger-api X.0.*
ARLAS-web-components
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes |
| Y | ARLAS front libraries version |
Incremented as soon as one of the ARLAS front libraries receives a modification of the Angular Inputs/Outputs or a modification of a Typescript interface or class |
| Z | ARLAS-web-components implementation version |
Incremented as soon as the ARLAS-web-components implementation receives a fix |
Info
ARLAS-web-components X.Y.Z fetches ARLAS-d3
ARLAS-web-contributors
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes |
| Y | ARLAS front libraries version |
Incremented as soon as one of the ARLAS front libraries receives a modification of the Angular Inputs/Outputs or a modification of a Typescript interface or class |
| Z | ARLAS-web-contributors implementation version |
Incremented as soon as the ARLAS-web-contributors implementation receives a fix |
Info
ARLAS-web-contributors X.Y.Z fetches ARLAS-web-core X.Y.*
ARLAS-web-core
Pattern: X.Y.Z
| Letter | Description | Increment |
|---|---|---|
| X | ARLAS Exploration Stack version |
Incremented as soon as one of the backends APIs changes |
| Y | ARLAS front libraries version |
Incremented as soon as one of the ARLAS front libraries receives a modification of the Angular Inputs/Outputs or a modification of a Typescript interface or class |
| Z | ARLAS-web-core implementation version |
Incremented as soon as the ARLAS-web-core implementation receives a fix |
Info
ARLAS-web-core X.Y.Z fetches arlas-api X.0.*