International-Data-Spaces-Association / ids-specification

The Dataspace Protocol is a set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications define the schemas and protocols required for entities to publish data, negotiate Agreements, and access data in a data space
https://docs.internationaldataspaces.org/dataspace-protocol/
Apache License 2.0
33 stars 14 forks source link

Releases folder & Github Pages action #179

Closed mkollenstart closed 10 months ago

mkollenstart commented 10 months ago

This pull request contains a new folder structure for releases of the DSP. Located in the releases folder.

Currently a sample release for v0.8 is created by copying all JSON and TTL files into the releases/v0.8 folder while keeping the original repository structure.

In the Github Action, all files in the releases folder will be published to Github Pages, resulting in a hosted structure of files with the correct MIME-types when fetching these files. Additionally, a head release will be created in the action that copies all the JSON and TTL files of the current HEAD of the repository to the releases/head folder to ensure the latest files are also included in the Github Pages.

After merging and updating the Github settings to enable Github pages, the files in the releases folder will be available under: https://international-data-spaces-association.github.io/ids-specification/

So for the v0.8 context.json the link will be: https://international-data-spaces-association.github.io/ids-specification/v0.8/common/schema/context.json

And for the latest context.json, the link will be: https://international-data-spaces-association.github.io/ids-specification/head/common/schema/context.json

matgnt commented 10 months ago

Why is the releases/v0.8/ part of this commit? I understood it will be created by the github action?

mkollenstart commented 10 months ago

The actual releases should be part of the repository, since Github Pages will be generated from a single point in the repository. So, therefore, releases should be actual commits to the repository and only a "release" called head will be created from the repository to ensure the latest unreleased state of the main branch will also be available in the Github Pages