diff --git a/.docker/Dockerfile b/.docker/Dockerfile index 74e919fb6f078ac3ade2756e716ad38b948cf2e2..cc95db8ea1827a22bc5d96dcbce6f434345ad4c6 100644 --- a/.docker/Dockerfile +++ b/.docker/Dockerfile @@ -28,5 +28,5 @@ COPY . /caosdb-octavelib WORKDIR /caosdb-octavelib RUN rm -rf .git -RUN pip3 install -r doc/requirements.txt -RUN pip3 install -r dev-requirements.txt +RUN pip3 install -U -r doc/requirements.txt +RUN pip3 install -U -r dev-requirements.txt diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5f9c978ffe351db0dd2eafa5c88f196674c52e63..dc3bf9a1f9327a4247d81f15b0b2c7c62d3e0e4e 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -47,6 +47,12 @@ build-testenv: image: docker:20.10 script: - DOCKER_BASE_IMAGE="${CPPLIB_REGISTRY_IMAGE}" + - if [[ "${CI_COMMIT_REF_NAME}" == release* ]] ; then + echo "Release detected, choosing cpplib image from 'main' branch." ; + DOCKER_BASE_IMAGE="$CI_REGISTRY/caosdb/src/caosdb-cpplib/testenv:main" ; + else + echo "CI_COMMIT_REF_NAME $CI_COMMIT_REF_NAME" ; + fi - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY - if docker pull "$DOCKER_BASE_IMAGE" ; then echo "DOCKER_BASE_IMAGE=${DOCKER_BASE_IMAGE}" ; diff --git a/.gitlab/issue_templates/Default.md b/.gitlab/issue_templates/Default.md new file mode 100644 index 0000000000000000000000000000000000000000..aa1a65aca363b87aff50280e1a86824009d2098b --- /dev/null +++ b/.gitlab/issue_templates/Default.md @@ -0,0 +1,28 @@ +## Summary + +*Please give a short summary of what the issue is.* + +## Expected Behavior + +*What did you expect how the software should behave?* + +## Actual Behavior + +*What did the software actually do?* + +## Steps to Reproduce the Problem + +*Please describe, step by step, how others can reproduce the problem. Please try these steps for yourself on a clean system.* + +1. +2. +3. + +## Specifications + +- Version: *Which version of this software?* +- Platform: *Which operating system, which other relevant software versions?* + +## Possible fixes + +*Do you have ideas how the issue can be resolved?* diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md new file mode 100644 index 0000000000000000000000000000000000000000..7859b7be21fb1c3eda91ee35173a8e3412a62066 --- /dev/null +++ b/.gitlab/merge_request_templates/Default.md @@ -0,0 +1,53 @@ +# Summary + +*Insert a meaningful description for this merge request here: What is the new/changed behavior? +Which bug has been fixed? Are there related issues?* + + +# Focus + +*Point the reviewer to the core of the code change. Where should they start reading? What should +they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the +specs, finding more corner cases, concrete questions)?* + + +# Test Environment + +*How to set up a test environment for manual testing?* + + +# Check List for the Author + +Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab +comments for the reviewer. They should guide the reviewer through the changes, explain your changes +and also point out open questions. For further good practices have a look at [our review +guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) + +- [ ] All automated tests pass +- [ ] Reference related issues +- [ ] Up-to-date CHANGELOG.md (or not necessary) +- [ ] Appropriate user and developer documentation (or not necessary) + - 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) + - Intent of new code + - Problems with old code + - Why this implementation? + + +# Check List for the Reviewer + +- [ ] 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) +- [ ] The test environment setup works and the intended behavior is reproducible in the test + environment +- [ ] In-code documentation and comments are up-to-date. +- [ ] Check: Are there specifications? Are they satisfied? + +For further good practices have a look at [our review guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md). + + +/assign me +/target_branch dev diff --git a/CHANGELOG.md b/CHANGELOG.md index 9bf7bff791342c1ca8d9c7fdec41c582e8e8f4c3..6656b72975953d09528561052c50a29be5721e98 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,13 @@ 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). -## [0.2.0] ## +## [0.2.1] - 2023-02-17 ## + +### Changed ### + +- Updated necessary Conan version to 1.54. + +## [0.2.0] - 2022-09-26 ## ### Added ### diff --git a/DESCRIPTION b/DESCRIPTION index 388cdd22875d01a080dd0d330962bd8ffa4b2365..74d244c4876ef01a15d88102f540db089038874e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ # See https://octave.org/doc/interpreter/The-DESCRIPTION-File.html Name: caosdb -Version: 0.2.0 -Date: 2022-09-22 +Version: 0.2.1 +Date: 2023-02-17 Author: Daniel Hornung <d.hornung@indiscale.com> Maintainer: Daniel Hornung <d.hornung@indiscale.com> Title: Octave and Matlab library for CaosDB diff --git a/README.md b/README.md index 57f87f95d1a1f3fcaab1f5be54db13b3b48d4aee..a2284f2b9a6d92d4a1b51646d48b0a5d30fbc4bf 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ when creating the merge request. This allows our team to work with you on your r - If you have a suggestion for the [documentation](https://docs.indiscale.com/caosdb-octavelib/), the preferred way is also a merge request as describe above (the documentation resides in `src/doc`). However, you can also create an issue for it. -- You can also contact us at **info (AT) caosdb.de** and join the +- You can also contact us at **info (AT) caosdb.org** and join the CaosDB community on [#caosdb:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org). diff --git a/RELEASE_GUIDELINES.md b/RELEASE_GUIDELINES.md index 7f162d59600e5b1ae12176c0bfc45b579b5cd922..c73c765d236106b48fc4288d6a00be0c9fb2d64c 100644 --- a/RELEASE_GUIDELINES.md +++ b/RELEASE_GUIDELINES.md @@ -34,6 +34,23 @@ guidelines of the CaosDB Project 1. On [Releases](https://gitlab.indiscale.com/caosdb/src/caosdb-octavelib/-/releases), click "New release" 2. Choose tag, type release title (same as tag), no milestone, possibly short release note, no manual assets are necessary, possibly link to documentation. + 1. Release title: `v0.2.0` (replace by actual release) + 2. Milestones: None + 3. Release date: today + 4. Release notes (replace release in link, copy from changelog file): + ``` +# Changelog # + +See [full changelog](https://gitlab.indiscale.com/caosdb/src/caosdb-octavelib/-/blob/v0.2.0/CHANGELOG.md). + +### Changed ### + +(Copy & paste from CHANGELOG.md) +``` + 5. Assets: + - URL: https://docs.indiscale.com/caosdb-octavelib/ + - Link title: Documentation + - Type: Other 8. Delete the release branch. diff --git a/dev-requirements.txt b/dev-requirements.txt index 9ee0f273c6981e930b34d25e3745ab2e002715e9..415bb8e6796d0cc532e30ab38f38c880d5116fb9 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -4,7 +4,7 @@ certifi==2021.10.8 chardet==4.0.0 charset-normalizer==2.0.7 colorama==0.4.4 -conan==1.52.0 +conan==1.54.0 deprecation==2.1.0 distro==1.6.0 fasteners==0.16.3 diff --git a/doc/Generate_Octave_Doc.m b/doc/Generate_Octave_Doc.m index 6f9839c4b7897f78f0bf9c7d2e0d53a70411a9bd..97c817fc02f1d3c9741a5044f83fd1eaaea76cf1 100644 --- a/doc/Generate_Octave_Doc.m +++ b/doc/Generate_Octave_Doc.m @@ -1,5 +1,5 @@ -% Copyright (C) 2021 IndiScale GmbH <info@indiscale.com> -% Copyright (C) 2021 Daniel Hornung <d.hornung@indiscale.com> +% Copyright (C) 2021-2023 IndiScale GmbH <info@indiscale.com> +% Copyright (C) 2021-2023 Daniel Hornung <d.hornung@indiscale.com> % % This file is a part of the CaosDB Project. % @@ -23,7 +23,7 @@ header = @(a_1, a_2, a_3) ... '<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">\n', ... ' <head>\n', ... ' <meta http-equiv="content-type" content="text/html; charset=utf-8" />\n', ... - ' <meta name="date" content="2022-09-22"/>\n', ... + ' <meta name="date" content="2023-02-17"/>\n', ... ' <meta name="generator" content="generate_html 0.4.0" />\n', ... ' <meta name="author" content="The Octave-Forge Community" />\n', ... ' <meta name="description" content="Octave-Forge is a collection of packages ', ... diff --git a/doc/conf.py b/doc/conf.py index 6fb4f451cc2ff08dc47158cafd0a280afd364401..025f3d7e414210d7bbd1881fb396a03ffaaaf82a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -23,14 +23,14 @@ import sphinx_rtd_theme # type: ignore # noqa: 401 # -- Project information ----------------------------------------------------- project = 'OctaveCaosDB' -copyright = '2022, IndiScale GmbH' +copyright = '2021-2023, IndiScale GmbH' author = 'Daniel Hornung' # The short X.Y version version = '0.2' # The full version, including alpha/beta/rc tags # Example: release = '0.5.2-rc2' -release = '0.2.0' +release = '0.2.1' # -- General configuration ---------------------------------------------------