diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md index 35c6d01c5904289b77fc7f1de9419ef91a1510e9..3629e0ca3695000863d8c254516f64bf59a7bf60 100644 --- a/.gitlab/merge_request_templates/Default.md +++ b/.gitlab/merge_request_templates/Default.md @@ -28,6 +28,7 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) - [ ] Up-to-date CHANGELOG.md (or not necessary) - [ ] Up-to-date JSON schema (or not necessary) - [ ] Appropriate user and developer documentation (or not necessary) + - Update / write published documentation (`make doc`). - How do I use the software? Assume "stupid" users. - How do I develop or debug the software? Assume novice developers. - [ ] Annotations in code (Gitlab comments) @@ -41,7 +42,8 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) - [ ] I understand the intent of this MR - [ ] All automated tests pass - [ ] Up-to-date CHANGELOG.md (or not necessary) -- [ ] Appropriate user and developer documentation (or not necessary) +- [ ] Appropriate user and developer documentation (or not necessary), also in published + documentation. - [ ] The test environment setup works and the intended behavior is reproducible in the test environment - [ ] In-code documentation and comments are up-to-date. diff --git a/CMakeLists.txt b/CMakeLists.txt index 51f80e9066a803f0b711e2536a600f88087a77bc..c4444c6668a0389a73e049f1d4491c4ec6f46923 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -20,7 +20,7 @@ cmake_minimum_required(VERSION 3.13) -set(libcaosdb_VERSION 0.2.2) +set(libcaosdb_VERSION 0.3.0) set(libcaosdb_COMPATIBLE_SERVER_VERSION_MAJOR 0) set(libcaosdb_COMPATIBLE_SERVER_VERSION_MINOR 9) set(libcaosdb_COMPATIBLE_SERVER_VERSION_PATCH 0) diff --git a/Makefile b/Makefile index 4be361a56cb09fa5359d5ef03ccff3064b2e4e3d..9a4abd9173578cbffc7a7b7260e8a681101fc5a6 100644 --- a/Makefile +++ b/Makefile @@ -45,20 +45,21 @@ endif help: @echo "Targets:" @echo " style - auto-format the source files." - @echo " conan-install - Install locally with Conan." - @echo -e " conan-create - Create conan binary package in the local conan\n"\ + @echo " conan-install-deps - Install dependencies locally with Conan." + @echo -e " conan-create - Create Conan binary package in the local conan\n"\ " repostory." + @echo " conan - Install dependencies, then build and install package." style: $(CLANG_FORMAT) -i --verbose \ $$(find test/ src/ include/ -type f -iname "*.cpp" -o -iname "*.h" -o -iname "*.h.in") .PHONY: style -conan-install: +conan-install-deps: conan install . -s $(CONAN_SETTINGS) || \ (echo "'conan install' failed, trying to build from sources..."; \ conan install . -s $(CONAN_SETTINGS) --build=missing) -.PHONY: conan-install +.PHONY: conan-install-deps conan-install-debug: conan install . -s $(CONAN_SETTINGS) -s build_type=Debug || \ @@ -75,7 +76,7 @@ conan-create-debug: .PHONY: conan-create-debug -conan: conan-install conan-create +conan: conan-install-deps conan-create .PHONY: conan doc: diff --git a/README.md b/README.md index 4750574a04da7d170c16858ddfcb82f789237150..b83bd0e8a47be696165b21fefa6dbf92883ef5f2 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ for LinkAhead and a part of the LinkAhead project. ## Setup -Please read the installation notes [online](https://docs.indiscale.com/caosdb-cpplib/Install_develop.html) or [in the source repository](doc/Install_develop.md) for instructions +Please read the installation notes [online](https://docs.indiscale.com/caosdb-cpplib/Install_develop.html) or [in the source repository](doc/Install_develop.rst) for instructions on how to build, use and develop this code. ## Further Reading diff --git a/conanfile.py b/conanfile.py index e86f49da94e88aba9cee145e45c1045230d24bc5..906ba04e9b3920f3d5d13d6bc568b0dd7c67696b 100644 --- a/conanfile.py +++ b/conanfile.py @@ -3,7 +3,7 @@ from conans import ConanFile, CMake, tools class CaosdbConan(ConanFile): name = "caosdb" - version = "0.2.2" + version = "0.3.0-dev" license = "AGPL-3.0-or-later" author = "Timm C. Fitschen <t.fitschen@indiscale.com>" url = "https://gitlab.indiscale.com/caosdb/src/caosdb-cpplib.git" diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md index aba1ff29bbaa11f977598baf4b588b9686790212..20438ea06893f3abf141cb4a82cc474812f362b9 100644 --- a/doc/CHANGELOG.md +++ b/doc/CHANGELOG.md @@ -5,6 +5,26 @@ 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] - YYYY-MM-DD ## +(*Maintainer*) + +### Added + +### Changed + +- Updated dependency versions. + +### Deprecated + +### Removed + +### Fixed + +### Security + +### Documentation + + ## [0.2.2] - 2023-06-15 ## (Timm Fitschen) diff --git a/doc/Install_develop.rst b/doc/Install_develop.rst index 5a102626bbf26bd9089677eb0d61db6f60c6ae17..bf4fb03102316f5f2e6e0b85337892317b0f0483 100644 --- a/doc/Install_develop.rst +++ b/doc/Install_develop.rst @@ -4,7 +4,7 @@ How to use and develop libcaosdb Dependencies ------------ -- See the `dependencies <DEPENDENCIES.md>`__ file, install with ``pip install -r requiremens.txt``. +- See the `dependencies <DEPENDENCIES.md>`__ file, install with ``pip install -r requiremens.txt``. Build ----- diff --git a/requirements.txt b/requirements.txt index f7bf0dbe928a9ca0d29702e7fc2b0895caf77616..b0410ad5624768205f16743a17bef2d9e34ead66 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,7 +2,7 @@ bottle==0.12.23 certifi==2022.9.24 charset-normalizer==2.1.1 colorama==0.4.6 -conan==1.54.0 +conan==1.61.0 distro==1.7.0 fasteners==0.18 future==0.18.2