Merge pull request #82 from OpenEnergyPlatform/develop

Publish fixed release v1.5.1

CHANGELOG.md

@@ -39,6 +39,8 @@ Here is a template for new release sections
 - Use  [GitHub projects](https://github.com/OpenEnergyPlatform/oemetadata/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

README.md

@@ -28,28 +28,31 @@ The oemetadata example and oemetadata template are licensed under [Creative Comm
 ## Usage Examples
 
 ```
-from metadata.v150.example import OEMETADATA_v150_EXAMPLE
+from metadata.latest.example import OEMETADATA_LATEST_EXAMPLE
 
-print(OEMETADATA_v150_EXAMPLE)
+print(OEMETADATA_LATEST_EXAMPLE)
 ```
 
 ```
-from metadata.v150.schema import OEMETADATA_v150_SCHEMA
+from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA
 
-print(OEMETADATA_v150_SCHEMA)
+print(OEMETADATA_LATEST_SCHEMA)
 ```
 
 ```
-from metadata.v150.template import OEMETADATA_v150_TEMPLATE
+from metadata.latest.template import OEMETADATA_LATEST_TEMPLATE
 
-print(OEMETADATA_v150_TEMPLATE)
+print(OEMETADATA_LATEST_TEMPLATE)
 ```
 
 ## Contributing
 
 For further contributing infos and conventions see: [CONTRIBUTING.md](./CONTRIBUTING.md)
 
-## Make PyPI release:
+## Release a new version
+See the complete instructions in the [RELEASE_PROCEDURE](./RELEASE_PROCEDURE.md).
+
+### Make PyPI release:
 
 First bump version in setup.py, then:
 

RELEASE_PROCEDURE.md

@@ -0,0 +1,25 @@
+# Release procedure
+ ## Pre-Release
+- View the GitHub project for the next release and check the 
+Status of all issues and PR's assigned to the project.
+If there are any open issues or PR's, decide if you want to include them
+them to be included in the upcoming release. Make sure that all changes are
+are included in the development branch before proceeding to the next steps.
+- Create a new folder named "vXXX" (release version) in the metadata and
+test directory. 
+	- In the metadata direcotry copy all files from latest to the 
+	new folder then adapt all .py files to the latest version and
+	update the id in schema.json.
+	- In test copy all files from previous oder latest version folder 
+	in test directory and adapt all tests (test_***.py files) to
+	the latest version.
+## Release
+- 1 Checkout a new branch from devolop branch named: release/oem-vX.X.X
+- 2 Update the following files: 
+	- Make sure all changes are documented in the changelog.md.
+	- Set the correct version number in the setup.py file.
+- 3 Commit and Push the changes.
+- 4 Create the Pull Request via the GitHub website and merge changes to 
+develop then merge develop in master branch.
+- 5 Create a new release via the GitHub website and tag the master branch.
+- 6 Update the PyPi (pip) Package [oep-metadata](https://pypi.org/project/oep-metadata/)