Skip to content

Latest commit

 

History

History
166 lines (112 loc) · 5.86 KB

CHANGELOG.md

File metadata and controls

166 lines (112 loc) · 5.86 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is inspired from Keep a Changelog and the versioning aim to respect Semantic Versioning.

Here is a template for new release sections

## Current

### Added
-
### Changed
- 
### Removed
-

## [0.0.0] - Release - Name of Release - 20YY-MM-DD

### Added
-
### Changed
-
### Removed
-

Current

Added

  • Added oemetadata version 2.0.0: #???

    • This includes restructured oemetadata: We now store metadata for each resource that is described in the oemetdata. A resource describes a files (CSV) or database table. Before it was not possible to add metadata to each resource. This change also alines the oemetadata specification with the requirements form frictionless datapackage v1.

  • Introduce a schema build system: #???

    • The build files (schema & script) are maintained for each version (starting form v1.6.0) within the new directory called "metadata/v200/build_source"
    • The schema is rather long and complex. We split the long schema.json into modules. The modules are assembled in a json file that specifies the structure of the final schema.json and it is called schema_structure.json.
    • We use json schema $ref elements to reference the schema modules and we provide code to resolve the reference´s and generate the complete schema.json.

  • Add code to generate a example.json based on the schema.json. We read the example values for each of the fields specified in the schema and generate the example. #???

Changed

  • Remove comment field as it holds information on how to fill out the metadata and therefore should not be part of the actual oemetadata but the documentation. #???

  • Update the schema json file content (schema generation still broken, add desired output) and fix the schema path in the script for generating examples (it pointed to an incorrect directory and file name) (#149)

Removed

[1.6.0] - Release - Introduce badges in json schema - 2023-05-30

Added

  • Add badge for all fields [PR#117]
  • Add CITATION.cff with list of authors (#111)

Changed

  • Separate examples from descripton and put into its own key-value pair [PR#117]
  • Add issue and PR templates (#116)
  • Update context field [PR#114]

Removed

[1.5.2] - Release - Fix missing json files in pypi package, Improve context.jsonld - 2022-11-18

  • Fix missing json files in pypi oemetadata package
  • Add github actions/workflwos to automate package build and upload process on test and production pypi index

Added

Changed

  • Update context.json in latest & v151 to ensure ontologically annotated metadata can be sparqled #99

[1.5.1] - Release - Ontology-Ready - 2022-02-21

Added

  • Use GitHub projects to organise releases
  • Add new example table to show connection to OEO
  • Add test for latest directory to CI [PR#74]
  • Add tests for v151 [PR#81]
  • Add release version directory for oem-v151

Changed

  • Update subject to work with OEO
  • Rename and update isAbout to work with OEO
  • Rename and update valueReference to work with OEO
  • Improve documentation
  • Update schema.json
  • Update CHANGELOG.md and give names to releases
  • Update CONTRIBUTING.md

[1.5.0] - Release - Get Some Semantics - 2021-11-18

Added

  • Add keys for linked data compatibility: @context, @id, subject, is_about, value_reference
  • Add context.json file
  • Add licence information to README.md

Changed

  • Clarify instructions for dealing with non-applicable keys (null) and missing values ("todo")
  • Make key 13.2 timeseries a list
  • Relocate development information from README.md to CONTRIBUTING.md
  • Update all .json files to v1.5.0
  • Reintroduce automated tests (CI) by switching form travis-ci to github actions [PR#63]
  • Updated schema.json for v1.5.0 now includes the new key title which describes the title of the curent field [PR#56] adapted from [PR#43]

Removed

  • Delete future directory

[1.4.1] Minor Release - Repo Upgrade - 2021-01-18

Added

  • Add directory for v1.4.1
  • Add tests for v1.4.1
  • Add current section to Changelog, documenting all changes in current branch and stage for release
  • Extend black options, COMMAND tox -v now shows exactly what code must be reformatted

Changed

  • Rename repository from "metadata" to "oemetadata"

[1.4.0] Release - It'll be a standard - 2021-01-11

Added

  • Add timeseries to temporal
  • Add context object for project information
  • Add object to contributors to decide between data and metadata
  • Add profile to resources according to datapackage standard
  • Add encoding to resources according to datapackage standard
  • Add schema to resources according to datapackage standard
  • Add type to fields for data types
  • Add primaryKey
  • Add foreignKeys
  • Add dialect
  • Add review
  • Add metaMetadata
  • Add _comment

Changed

  • Rename url to path according to datapackage standard

[1.0.1] Initial Release - Hello OEMetadata - 2019-11-07

Added

  • OEMetadata version v1.3.0 metadata schema, example, template
  • OEMetadata version v1.4.0 metadata schema, example, template
  • Python implementation and tests for schema, example, template of v1.3.0
  • Python implementation and tests for schema, example, template of v1.4.0
  • Implementation of metaschema (draft07) and test of metaschema