Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.48 KB

RELEASE_NOTES.md

File metadata and controls

53 lines (34 loc) · 2.48 KB

5.0.0 - (Released 2024-06-21)

Support full semantic versions with suffixes

4.0.1 - (Released 2024-04-30)

Update pinned dependencies

4.0.0 - (Released 2024-04-30)

Update to AVPRIndex v0.1.1 and AVPRClient v0.0.5

3.0.0 - (Released 2024-04-30)

3.0.0 release of the ArcValidationPackages API.

This library provides a set of functions to retrieve, cache, manage, and execute validation packages for ARCs.

2 package sources are supported:

The difference between theses sources is that Preview packages are a snapshot of the AVPR staging area, where packages could still changed, while AVPR packages are the final versions of the packages and immutable.

Note that matching versions available from both sources should be the same, but no guarantee is given. Stable packages should always be consumed from the AVPR API.

Locally installed packages are managed in a directory (by default, <SpecialFolder.ApplicationData>/nfdi4plants/arc-validate in ``) containing the following files and folders:

containing these files:

<SpecialFolder.ApplicationData>/nfdi4plants/arc-validate
│   validation-packages-config.json
│ 
├───package-cache-preview
│       validation-packages-cache.json
│
└───package-cache-release
        validation-packages-cache.json
  • validation-packages-config.json contains a local copy of the AVPR preview index and some config settings
  • package-cache-preview contains validation-packages-cache.json file that contains metadata of installed preview validation packages, and the cached packages themselves
  • package-cache-release contains validation-packages-cache.json file that contains metadata of installed AVPR validation packages, and the cached packages themselves

Installed validation packages can be executed via the ScriptExecution API, which uses FSI to execute the F# scripts.

A Top-level API using multiple integrated functions to perform common tasks is provided, consisting of the following classes:

  • Common - Functionality that does not depend on the package source:
  • Preview - Functionality for managing preview validation packages:
  • AVPR - Functionality for managing AVPR validation packages: