diff --git a/CHANGELOG.md b/CHANGELOG.md index fd2bbfd27503488cbb7b2e7aef30ff959f3f323d..e4ea01d37e5eda76fb668039c2ae615e0f5891da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added ### +### Changed ### + +### Deprecated ### + +### Removed ### + +### Fixed ### + +### Security ### + +## [0.4.1] 2021-02-10 ## + +### Added ### + * Versioning support (experimental). The version db.Version class can represents particular entity versions and also the complete history of an entity. diff --git a/DEPENDENCIES.md b/DEPENDENCIES.md new file mode 100644 index 0000000000000000000000000000000000000000..fca1fdf0e87f3efe2d1f4646ebcf160c3ea75879 --- /dev/null +++ b/DEPENDENCIES.md @@ -0,0 +1,4 @@ +Python 3.5 or later +pip 20.0.2 or later + +Any other dependencies are being installed via pip diff --git a/RELEASE_GUIDELINES.md b/RELEASE_GUIDELINES.md index 02be5c1ad19f6a3a405fb08d62e23dab350ad445..dd6d5af4c43e1eea17c70f29da837c905694fed4 100644 --- a/RELEASE_GUIDELINES.md +++ b/RELEASE_GUIDELINES.md @@ -16,21 +16,27 @@ 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. Check all general prerequisites. +2. Update CHANGELOG.md -3. Prepare [setup.py](./setup.py): Update the `MAJOR`, `MINOR`, `MICRO`, `PRE` +3. Check all general prerequisites. + +4. Prepare [setup.py](./setup.py): Check the `MAJOR`, `MINOR`, `MICRO`, `PRE` variables and set `ISRELEASED` to `True`. Use the possibility to issue pre-release versions for testing. -4. Merge the release branch into the master branch. +5. Merge the release branch into the master branch. -5. Tag the latest commit of the master branch with `v<VERSION>`. +6. Tag the latest commit of the master branch with `v<VERSION>`. -6. Delete the release branch. +7. Delete the release branch. -7. Remove possibly existing `./dist` directory with old release. +8. Remove possibly existing `./dist` directory with old release. -8. Publish the release by executing `./release.sh` with uploads the caosdb +9. Publish the release by executing `./release.sh` with uploads the caosdb module to the Python Package Index [pypi.org](https://pypi.org). -9. Merge the master branch back into the dev branch. +10. Merge the master branch back into the dev branch. + +11. After the merge of master to dev, start a new development version by + setting `ISRELEASED` to `False` and by increasing at least the `MIRCO` + version in [setup.py](./setup.py) diff --git a/setup.py b/setup.py index 4ab2d7669cc4f6d3f4873c0265da6c8cf06932ba..c1c6b287a3044399403db810e851abb3a9b36985 100755 --- a/setup.py +++ b/setup.py @@ -49,7 +49,7 @@ MAJOR = 0 MINOR = 4 MICRO = 1 PRE = "" # e.g. rc0, alpha.1, 0.beta-23 -ISRELEASED = False +ISRELEASED = True if PRE: VERSION = "{}.{}.{}-{}".format(MAJOR, MINOR, MICRO, PRE)