From 1f6247f5134995f38035aca45107565aa054ff1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1=C5=A1=20H=C3=A1jek?= <xhajek8@fi.muni.cz> Date: Thu, 23 Jan 2025 21:21:44 +0100 Subject: [PATCH] * change ordering of changes * fix version * update definiton tutorial from 0.17.0 to 0.18.1 --- docs/tech/architecture/definitions/upgrade.md | 27 +++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/tech/architecture/definitions/upgrade.md b/docs/tech/architecture/definitions/upgrade.md index 0faafe1..cc999b6 100644 --- a/docs/tech/architecture/definitions/upgrade.md +++ b/docs/tech/architecture/definitions/upgrade.md @@ -27,9 +27,9 @@ If you want to upgrade the current definition to a new version, use the followin ## Example: * Current version: **0.12.1** -* New version: **0.17.0** +* New version: **0.18.1** -* In the `config.yml` change the field `version` from 0.12.1 to 0.17.0. +* In the `config.yml` change the field `version` from 0.12.1 to 0.18.1. ### 0.12.1 to 0.13.0 1. In the [CHANGELOG](CHANGELOG.md), find the first subsequent definition version to the current version, which is, in this case, **0.13.0**. @@ -85,6 +85,29 @@ If you want to upgrade the current definition to a new version, use the followin 7. Check the `tools.yml` against the `tools.yml` structure in the [definition documentation](README.md). 8. Check the `questionnaires.yml` against the `questionnaires.yml` structure in the [definition documentation](README.md). +### 0.17.0 to 0.17.1 +1. In the [CHANGELOG](CHANGELOG.md), find the first subsequent definition version to the current version, which is, in this case, **0.17.1**. +2. The change lies in adding embedding options into content fields. The change does not alter the current definition. +3. Skip the change. + +### 0.17.1 to 0.17.2 +1. In the [CHANGELOG](CHANGELOG.md), find the first subsequent definition version to the current version, which is, in this case, **0.17.2**. +2. Fixed embedding in email templates. No change is required. +3. Skip the change. + +### 0.17.2 to 0.18.0 +1. In the [CHANGELOG](CHANGELOG.md), find the first subsequent definition version to the current version, which is, in this case, **0.18.0**. +2. The first change is adding the `content` field to `default_response` in tools. +3. Fix `default_response` according to [definition documentation](README.md). +4. Check the `tools.yml` against the `tools.yml` structure in the [definition documentation](README.md). +5. The second change lies in adding the optional field `requires_input` to `tools.yml`. This new feature allows you to use tools without input parameters. So, it is up to the designer if such a change is desired. +6. Otherwise, skip the change. + +### 0.18.0 to 0.18.1 +1. In the [CHANGELOG](CHANGELOG.md), find the first subsequent definition version to the current version, which is, in this case, **0.18.1**. +2. The change lies in adding an optional `note` to `questionnaires.yml`. This feature only adds additional information to questionnaires, so it is up to the designer. +3. Otherwise, skip the change. + * Create a new .zip archive and upload it to the IXP. * The upload process will check the definition for errors. -- GitLab