Improve documentation #204

.github/workflows/documentation.yml

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2024 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut
+# SPDX-License-Identifier: MIT
+
+name: documentation (develop branch)
+on:
+  push:
+    branches:
+      - develop
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v3
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - name: Setup git
+        run: |
+          git config --global user.name Documentation
+          git config --global user.email docs@example.com
+      - run: pip install --upgrade -r requirements.txt
+      - run: |
+          git fetch origin gh-pages --verbose
+          mike deploy --push --update-aliases develop

.github/workflows/pypi-publish.yml → .github/workflows/publish_pypi.yml

@@ -2,21 +2,21 @@
 # SPDX-FileCopyrightText: 2024 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
-name: Build 📦 and release on pypi
+name: Build and publish on PyPI
 
 on:
   release:
     types: [published]
 
 jobs:
   build-n-publish:
-    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    name: Build and publish on PyPI
     runs-on: ubuntu-latest
     environment: pypi-publish
     steps:
     - uses: actions/checkout@master
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+    - name: Set up Python
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
 
@@ -33,7 +33,7 @@ jobs:
         --sdist
         --wheel
         --outdir dist/
-    - name: Publish distribution 📦 to PyPI
+    - name: Publish distribution to PyPI
       if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1
       with:

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

@@ -2,7 +2,7 @@
 # SPDX-FileCopyrightText: 2024 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
-name: Build and release on pypi tests
+name: Build and publish on Test PyPI
 
 on:
   push:
@@ -12,16 +12,15 @@ on:
 
 jobs:
   build-n-publish:
-    name: Build and publish Python 🐍 distributions 📦 to TestPyPI
+    name: Build and publish on Test PyPI
     runs-on: ubuntu-latest
     environment: pypi-publish
     steps:
     - uses: actions/checkout@master
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+    - name: Set up Python
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
-
     - name: Install pypa/build
       run: >-
         python -m
@@ -35,7 +34,7 @@ jobs:
         --sdist
         --wheel
         --outdir dist/
-    - name: Publish distribution 📦 to Test PyPI
+    - name: Publish distribution to Test PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         password: ${{ secrets.PYPI_TEST }}

.github/workflows/reuse.yml

@@ -11,4 +11,4 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: REUSE Compliance Check
-        uses: fsfe/reuse-action@v4
+        uses: fsfe/reuse-action@v4

CHANGELOG.md

@@ -36,6 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Update example contributors and roles [(#225)](https://github.com/OpenEnergyPlatform/oemetadata/pull/225)
 - Update keyword titles [(#239)](https://github.com/OpenEnergyPlatform/oemetadata/pull/239)
 - Update documentation with logos and cardinality [(#242)](https://github.com/OpenEnergyPlatform/oemetadata/pull/242)
+- Update documentation with versioning [(#243)](https://github.com/OpenEnergyPlatform/oemetadata/pull/243)
 
 ### Removed
 - [(#)]()

docs/development/release/index.md

@@ -1,19 +1,11 @@
 # Release
 
-- RELEASE_PROCEDURE.md
-- VERSION
-- MANIFEST.in
-- .bumpversion.cfg
+The software release has four main goals:
 
+1. Merge the new features to the `production` branch
+2. Create a [GitHub Release](https://github.com/OpenEnergyPlatform/oemetadata/releases)
+3. Update the documentation
+4. Publish a new version of the package at PyPI
 
-## Release a new version
-See the complete instructions in the [RELEASE_PROCEDURE](./RELEASE_PROCEDURE.md).
-
-### Make PyPI release:
-
-First update version in setup.py, then:
-
-```
-python3 setup.py sdist bdist_wheel
-twine upload dist/*
-```
+The 📝 [RELEASE_PROCEDURE.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/RELEASE_PROCEDURE.md)
+contain detailed instructions to do a release.