diff --git a/CHANGELOG.md b/CHANGELOG.md index a298f8a8d33b4219428e5e8f8819e978debdd62c..0b12b4f8f1dd469b0545b94f5befaba068223a3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,27 +5,17 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] ## - -### Added ### - -### Changed ### - -### Deprecated ### - -### Removed ### - -### Fixed ### - -### Security ### - -## [0.0.2] - 2021-XX-XX ## +## [0.1.0] - 2022-02-01 ## ### Added ### - Full functionality of libcaosdb mapped to Octave / Matlab. - Basic documentation (check out the integration tests for more examples). +### Changed ### + +- Accepts any libcaosdb >= 0.1 now. + ## [0.0.1] - 2021-08-12 ## ### Added ### diff --git a/DEPENDENCIES.md b/DEPENDENCIES.md index 97b2a92980109912b1dfe7878cd94ccb15c8c84f..2123038315719efb108e8a98e319c89fd9ddb952 100644 --- a/DEPENDENCIES.md +++ b/DEPENDENCIES.md @@ -2,7 +2,7 @@ * caosdb-cpplib * octave >= 4.4 -* liboctave-dev ? +* liboctave-dev (tested with 6.2.0) ## Useful tools ## diff --git a/DESCRIPTION b/DESCRIPTION index 0b13ca6d2a364971dec95324d34d9dca4c721915..e9869812b76e03d92741a6ea0495c682eeede7be 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ # See https://octave.org/doc/interpreter/The-DESCRIPTION-File.html Name: caosdb -Version: 0.0.2-alpha -Date: 2021-07-09 +Version: 0.1.0 +Date: 2022-02-01 Author: Daniel Hornung <d.hornung@indiscale.com> Maintainer: Daniel Hornung <d.hornung@indiscale.com> Title: Octave and Matlab library for CaosDB diff --git a/RELEASE_GUIDELINES.md b/RELEASE_GUIDELINES.md index 31d7799839315bc2d2f5c48eff9c263e571bc978..fb5a774632fd7c2978abe48241efa2ed41c22d55 100644 --- a/RELEASE_GUIDELINES.md +++ b/RELEASE_GUIDELINES.md @@ -15,18 +15,26 @@ guidelines of the CaosDB Project 1. Create a release branch from the dev branch. This prevents further changes to the code base and a never ending release process. Naming: `release-<VERSION>` -2. Update CHANGELOG.md +2. Update CHANGELOG.md: + 1. Rename the *Unreleased* section to the new version. + 2. Remove empty subsections. 3. Check all general prerequisites. -4. Merge the release branch into the main branch. +4. Check version numbers: + 1. In `doc/conf.py` + 2. In `DESCRIPTION`. Also check the date here. -5. Tag the latest commit of the main branch with `v<VERSION>`. +5. Merge the release branch into the main branch. -6. Delete the release branch. +6. Tag the latest commit of the main branch with `v<VERSION>`. -7. Merge the main branch back into the dev branch. +7. Delete the release branch. -8. After the merge of main to dev, start a new development version by increasing at least the +8. Merge the main branch back into the dev branch. + +9. After the merge of main to dev, start a new development version by increasing at least the `MICRO` version. + 1. Re-add an *Unreleased* section to the CHANGELOG.md, with all subsections. + 2. Increase version number in `doc/conf.py` diff --git a/doc/conf.py b/doc/conf.py index 499d4f6e3f75b45869d4997d8a14b46497fe6238..e9d14fca2c2e4a6f3722cddd40dff5751e9095e0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -17,7 +17,7 @@ # sys.path.insert(0, os.path.abspath('../caosdb')) -import sphinx_rtd_theme +import sphinx_rtd_theme # type: ignore # noqa: 401 # -- Project information ----------------------------------------------------- @@ -27,10 +27,10 @@ copyright = '2021, IndiScale GmbH' author = 'Daniel Hornung' # The short X.Y version -version = '0.0' +version = '0.1' # The full version, including alpha/beta/rc tags -#release = '0.5.2-rc2' -release = '0.0.2-alpha' +# Example: release = '0.5.2-rc2' +release = '0.1' # -- General configuration --------------------------------------------------- @@ -67,7 +67,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] +exclude_patterns = [] # type: list[str] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None