Merge pull request #200 from OpenEnergyPlatform/release-v2.0.0

Release v2.0.0 Halloween Special 🎃🍭🍬🍾

.github/ISSUE_TEMPLATE/issue_template_bug.md

@@ -28,4 +28,4 @@ Describe possible ideas for solution and evaluate advantages and disadvantages.
 * Environment setup and (python) version: 
 
 ## Workflow checklist
-- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md)
+- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md)

.github/ISSUE_TEMPLATE/issue_template_release.md

@@ -0,0 +1,30 @@
+---
+name: Release Issue
+about: For a new release
+title: Release - Minor Version - 2.1.0
+labels: "enhancement"
+assignees: 'Ludee'
+
+---
+
+## Description of the release
+
+Describe the release in as much detail as possible. 
+
+## Details of the release
+
+**Name:** Find an appropriate and memorable name for the release that will help it be remembered.
+**Git tag:** v2.1.0 "OEMetadata Minor Release v2.1.0"
+**Release Manager:** Choose a responsible person.
+**Date:** Arrange a convenient date
+
+## Workflow checklist
+- [ ] I am aware of the workflow in [RELEASE_PROCEDURE.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/RELEASE_PROCEDURE.md)
+- [ ] 4. 🐙 Create a `Draft GitHub Release`
+- [ ] 5. 💠 Create a `release` branch
+- [ ] 6. 📝 Update the version files (CHANGELOG.md, CITATION.cff)
+- [ ] 7. 🐙 Create a Release Pull Request
+- [ ] 8. 💠 Set the `Git Tag`
+- [ ] 9. 🐙 Publish `GitHub Release`
+- [ ] 10. 💻 Update the documentation
+- [ ] 11. 🐙 Set up new development

.github/ISSUE_TEMPLATE/issue_template_user_kudos.md

@@ -0,0 +1,17 @@
+---
+name: User Kudos Issue
+about: User Community - Give kudos to the project
+title: Add new user to USERS.cff
+labels: user
+assignees: ''
+
+---
+
+I thank the developers of the project. <br>
+Please add my information to the file [USERS.cff](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/USERS.cff).
+
+family-names: 
+given-names: 
+alias: 
+affiliation: 
+orcid: 

.github/pull_request_template.md

@@ -23,6 +23,7 @@ Closes #
 - [ ] 🐙 Follow the workflow in [CONTRIBUTING.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md)
 - [ ] 📝 Update the [CHANGELOG.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CHANGELOG.md)
 - [ ] 📙 Update the documentation
+- [ ] 🐙 Assign a reviewer to the PR
 
 ### Reviewer
 - [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md#40-let-someone-else-review-your-pr)

.github/workflows/gh-pages.yml

@@ -0,0 +1,21 @@
+name: gh-pages
+on:
+  push:
+    branches:
+      - production
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install --upgrade -r requirements.txt
+      - run: mkdocs gh-deploy --force

.github/workflows/metadata-test.yml

@@ -9,9 +9,9 @@ name: Automated tests
 
 on:
   push:
-    branches: [ develop, master]
+    branches: [ develop, production]
   pull_request:
-    branches: [ develop, master ]
+    branches: [ develop, production ]
 
 jobs:
   test:    

.github/workflows/pypi-publish.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: pypi-publish
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@production
     - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:

.github/workflows/test-pypi-publish.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: pypi-publish
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@production
     - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:

CHANGELOG.md

@@ -1,65 +1,83 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+All notable changes to this project will be documented in this file. <br>
+For each version, important additions, changes and removals are listed here.
 
-The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and the versioning aim to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-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
+## [2.0.0] - Major Release - Refactor OEMetadata for NFDI
 
 ### Added
+- Add OEMetadata version 2.0: [#144](https://github.com/OpenEnergyPlatform/oemetadata/issues/144)
+- Introduce a schema build system: [#105](https://github.com/OpenEnergyPlatform/oemetadata/pull/105)
+  - The build files (schema & script) are maintained for each version (starting form v1.6.0) within the new directory called "metadata/(version)/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.
+  - It uses JSON schema $ref elements to reference the schema modules, and it provides code to resolve the reference´s and generate the complete schema.json.
+- Add code to generate an 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. [#105](https://github.com/OpenEnergyPlatform/oemetadata/pull/105)
+- Add updated context.json [(#154)](https://github.com/OpenEnergyPlatform/oemetadata/pull/154)
+- Add ``embargoPeriod`` section with keys ``start``, ``end``, ``isActive`` [(#155)](https://github.com/OpenEnergyPlatform/oemetadata/pull/155)
+- Add ``path`` to ``contributors`` [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+- Add organization to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+- Add roles to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+- Add section for ``Linked Data`` keys [(#159)](https://github.com/OpenEnergyPlatform/oemetadata/pull/159)
+- Add mandatory fields to the json schema (Iron Badge) [(#160)](https://github.com/OpenEnergyPlatform/oemetadata/pull/160)
+- Add key ``copyrightStatement`` to ``sources`` [(#162)](https://github.com/OpenEnergyPlatform/oemetadata/pull/162)
+- Add key nullable to fields section (columns) [(#161)](https://github.com/OpenEnergyPlatform/oemetadata/pull/161)
+- Add explicit json types [(#166)](https://github.com/OpenEnergyPlatform/oemetadata/pull/166)
+- Add key ``topics`` to ``general`` [(#170)](https://github.com/OpenEnergyPlatform/oemetadata/pull/170)
+- Add badge labels to documentation [(#175)](https://github.com/OpenEnergyPlatform/oemetadata/pull/175)
+- Implement schema build system v1: Enhance the resolve and generation module [(#180)](https://github.com/OpenEnergyPlatform/oemetadata/pull/180)
+- Add basic documentation with MkDocs [(#184)](https://github.com/OpenEnergyPlatform/oemetadata/pull/184)
+- Add key ``publisher`` to ``context`` [(#191)](https://github.com/OpenEnergyPlatform/oemetadata/pull/191)
+- Add array ``authors`` to ``sources``. [(#193)](https://github.com/OpenEnergyPlatform/oemetadata/pull/193)
+- Add ``year`` to ``sources`` [(#194)](https://github.com/OpenEnergyPlatform/oemetadata/pull/194)
+- Add key ``description`` to ``collection`` and update badges [(#195)](https://github.com/OpenEnergyPlatform/oemetadata/pull/195)
+- Add mappings to DCAT-AP to the documentation [(#198)](https://github.com/OpenEnergyPlatform/oemetadata/pull/198)
+- Add issue template for user kudos [(#199)](https://github.com/OpenEnergyPlatform/oemetadata/pull/199)
 
 ### 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. [#105](https://github.com/OpenEnergyPlatform/oemetadata/pull/105)
+- 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)](https://github.com/OpenEnergyPlatform/oemetadata/pull/149)
+- Update broken Link in key description example [(#159)](https://github.com/OpenEnergyPlatform/oemetadata/pull/159)
+- Update ``resource/profile`` to ``resource/type`` [(#164)](https://github.com/OpenEnergyPlatform/oemetadata/pull/164)
+- Update links in context.json and example.json for all versions [(#167)](https://github.com/OpenEnergyPlatform/oemetadata/pull/167)
+- Restrict the version number to only major and minor versions since 2.0 [(#168)](https://github.com/OpenEnergyPlatform/oemetadata/pull/168)
+- Update all descriptions and examples [(#175)](https://github.com/OpenEnergyPlatform/oemetadata/pull/175)
+- Build scripts use a settings file to share variables [(#177)](https://github.com/OpenEnergyPlatform/oemetadata/pull/177)
+- Refactor the ``spatial`` section and add new keys for location: ``address``, ``@id``, ``latitude``, ``longitude`` and for extent: ``name``, ``@id``, ``resolutionValue``, ``resolutionUnit``, ``boundingBox``, ``crs`` [(#179)](https://github.com/OpenEnergyPlatform/oemetadata/pull/179)
+- Move ``linkedData`` keys to the top of the resource [(#183)](https://github.com/OpenEnergyPlatform/oemetadata/pull/183)
+- Update order of keys in section context [(#191)](https://github.com/OpenEnergyPlatform/oemetadata/pull/191)
 
 ### Removed
--
+- Remove email from contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+- Remove all additionalProperties is false [(#163)](https://github.com/OpenEnergyPlatform/oemetadata/pull/163)
+- Remove duplicate keys from resources [(#165)](https://github.com/OpenEnergyPlatform/oemetadata/pull/165)
+- Remove linkedData section and keys [(#176)](https://github.com/OpenEnergyPlatform/oemetadata/pull/176)
+
 
 ## [1.6.0] - Release - Introduce badges in json schema - 2023-05-30
 
 ### Added
-
-- Add badge for all fields [PR#117]
+- Add badge for all fields [PR#117](https://github.com/OpenEnergyPlatform/oemetadata/pull/117)
 - Add CITATION.cff with list of authors [(#111)](https://github.com/OpenEnergyPlatform/oemetadata/pull/111)
 
 ### Changed
-- Separate examples from descripton and put into its own key-value pair [PR#117]
+- Separate examples from description and put into its own key-value pair [(PR#117)](https://github.com/OpenEnergyPlatform/oemetadata/pull/117)
 - Add issue and PR templates [(#116)](https://github.com/OpenEnergyPlatform/oemetadata/pull/116)
-- Update context field [PR#114]
+- Update context field [(PR#114)](https://github.com/OpenEnergyPlatform/oemetadata/pull/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
+## [1.5.2] - Release - Fix Repo and Package - 2022-11-18
 
 ### Added
+- Add GitHub actions to automate package build and upload process on test and production pypi index
 
 ### Changed
-- Update context.json in latest & v151 to ensure ontologically annotated metadata can be sparqled #99
+- Fix missing json files in pypi oemetadata package
+- Update context.json in latest & v151 to ensure ontologically annotated metadata can be sparkled #99
+
 
 ## [1.5.1] - Release - Ontology-Ready - 2022-02-21
 
@@ -79,6 +97,7 @@ Here is a template for new release sections
 - Update CHANGELOG.md and give names to releases
 - Update CONTRIBUTING.md
 
+
 ## [1.5.0] - Release - Get Some Semantics - 2021-11-18
 
 ### Added
@@ -91,12 +110,13 @@ Here is a template for new release sections
 - 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]
+- 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 current field [PR#56] adapted from [PR#43]
 
 ### Removed
 - Delete future directory
 
+
 ## [1.4.1] Minor Release - Repo Upgrade - 2021-01-18
 
 ### Added
@@ -108,6 +128,7 @@ Here is a template for new release sections
 ### Changed
 - Rename repository from "metadata" to "oemetadata"
 
+
 ## [1.4.0] Release - It'll be a standard - 2021-01-11
 
 ### Added
@@ -128,6 +149,7 @@ Here is a template for new release sections
 ### Changed
 - Rename ``url`` to ``path`` according to datapackage standard
 
+
 ## [1.0.1] Initial Release - Hello OEMetadata - 2019-11-07
 
 ### Added

CITATION.cff

@@ -28,7 +28,7 @@ authors:
 title: "Open Energy Family - Open Energy Metadata (OEMetadata)"
 type: software
 license: MIT
-version: 1.5.2
+version: 2.0.0
 doi: 
-date-released: 2022-11-18
+date-released: 2024-10-31
 url: "https://github.com/OpenEnergyPlatform/oemetadata"