Skip to content

Commit

Permalink
Update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
kMutagene committed Apr 30, 2024
1 parent 3779535 commit 57c7be9
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 2 deletions.
1 change: 0 additions & 1 deletion src/ARCExpect/ARCExpect.fsproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
<ItemGroup>
<None Include="packages.lock.json" />
<None Include="RELEASE_NOTES.md" />
<Compile Include="InternalUtils.fs" />
<Compile Include="StringValidationPattern.fs" />
Expand Down
20 changes: 20 additions & 0 deletions src/ARCExpect/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
### 2.0.0 - (Released 2024-04-30)

Major rework and improvements of the **ARCExpect API**. The main changes are:

- Built-in mechanisms for validating ARCs against the ARC specification

- Built-in validation package to validate against ARC spec v2.0.0-draft

- **New Validate functions**:
- `SatisfiesPredicate` for `Param` and `ParamCollection`

- **New `Setup` and `Execute` functions**:
- `Setup` can be used in validation package code to aggregate package metadata, even from frontmatter yaml.
- `Execute` now creates a spec v2 compliant output folder with the junit report, badge, and a new json report.

- **Addition of `Validation Summary` output**:
- In addition to JUnit report and badge creation, a json file combining the test results and validation package metadata is created by `Execute.*` functions.
- This file is intended to be used for further processing of the validation results, e.g. in a CQC pipeline.


### 1.0.1 - (Released 2024-02-27)

Add Pipeline execution function that generates ARC-spec v2 draft compliant output folder.
Expand Down
42 changes: 41 additions & 1 deletion src/ARCValidationPackages/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
### 1.0.0 - tbd
### 1.0.0 - (Released 2024-04-30)

Initial 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:

- `Preview` packages are pulled from the `avpr-preview-index.json` file attached to the [Latest preview index release of the AVPR](https://github.com/nfdi4plants/arc-validate-package-registry/releases/tag/preview-index)
- `AVPR` packages are pulled directly via the [AVPR API](https://avpr.nfdi4plants.org/swagger/index.html)

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:

0 comments on commit 57c7be9

Please sign in to comment.