This issue serves as a collection of todos for the release process of v0.0.4. We use oemof's how to release as an orientation (See a boiled-down version of the release todos below): https://github.com/oemof/oemof/wiki/How-to-release
[x] Keep an eye on open issues that are set to your release but seem to be forgotten.
[x] Check that the docs look good.
[x] Check headers of python scripts
[x] Check fresh installation and run
[x] Check that oemoflex contains all necessary features/fixes
[x] Upload raw data to zenodo if it has changed
[x] Download raw data from zenodo
Day of release
Optional: Open a release branch to avoid conflicts with other uses while the release progress.
[x] Close "forgotten" issues with a recapitulatory comment or set them to a later release if they are still important.
Test if it works
[x] Install in a fresh environment
[x] Examples
[x] Scenarios
[x] Plots
[x] Tables
[x] Reports
[x] Check for obsolete snakemake rules/options
If you have failing test fix them or postpone the release.
[x] Check the whatsnew-file
[x] Check if the latest documentation looks right at readthedocs.
[x] Change the version number everywhere!!! [TODO] (e.g. from 0.2.1dev to 0.2.1) -> pyproject.yaml and docs/conf.py
[x] If everything seems to work, merge the release branch into the main branch. (--no-ff)
[x] Push your local main branch to the remote.
[x] Set a release on github. Select the main branch (default: dev)! A label is set automatically.
[x] Use git fetch to see the label in your local main branch.
[x] Merge the release branch into the dev branch. (--no-ff)
[x] Remove the obsolete release branch.
[x] Prepare the dev branch for further development: Adapt the version number at (e.g. from 0.2.1 to 0.2.2dev). Also add a new whatsnew file and a link in the whatsnew.rst file. Open the file locally or use the RAW button to see the links.
[x] Edit-Zenodo-entry
[x] Close the release issue with informations for the community and relax
Content for the release issue
This issue serves as a collection of todos for the release process of v0.0.4. We use oemof's how to release as an orientation (See a boiled-down version of the release todos below): https://github.com/oemof/oemof/wiki/How-to-release
Preparation
Day of release
pyproject.yaml
anddocs/conf.py
git fetch
to see the label in your local main branch.