Skip to content

How to upgrade the definition version?

If you want to upgrade the current definition to a new version, use the following CHANGELOG.

How to proceed:

  1. Take your current definition, and in config.yml, check the version.

  2. Change the version in config.yml to a new version.

  3. Use the CHANGELOG and start making changes step by step from your current version to the newest version that is compatible with IXP.

  4. Make one single change at a time.

  5. Be sure to make the change for all the concerning files and their attributes before proceeding with the following change.

  6. Each version contains information about changes and a structured description of affected files and their arguments.

  7. Note that not every change is reflected in the files; some changes are only concerned with the behavior of certain definition aspects rather than syntax changes in the YAML files.

  8. Lastly, check the new version against definition documentation to see if the arguments in the files are the same.

  9. Zip the definition and upload it to the IXP for the last validation.

  10. Done. Enjoy your upgraded version!

Example:

  • Current version: 0.23.3

  • New version: 0.24.7

  • In the config.yml change the field version from 0.23.3 to 0.24.7.

0.23.3 to 0.24.0

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.0.
  2. The breaking change alters the behaviour of final milestones in a way that when such a milestone is reached, it stops the exercise (for synchronous exercises, all teams must reach it). This change does not alter the definition syntactically but can break exercises if allowed to be reached prematurely.
  3. Check the usage of final milestones.
  4. If the behaviour is as intended, skip the change.
  5. Else, edit final milestones usage according to expected behaviour.
  6. If not skipped, check all the edited files against the structure in the definition documentation.

0.24.0 to 0.24.1

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.1.
  2. The change lies in adding a new optional field delay for questionnaires. The feature does not break syntax of the previous version of the definition.
  3. Skip the change.

0.24.1 to 0.24.2

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.2.
  2. The change lies in adding optional activation of the performance overlay after exercise is finished. The feature does not break syntax of the previous version of the definition.
  3. Skip the change.

0.24.2 to 0.24.3

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.3.
  2. These changes lie in adding new fields to the config.yml to describe the definition. Except for name, these fields are optional.
  3. Add name into the config.yml.
  4. Check all the edited files against the structure in the definition documentation.

0.24.3 to 0.24.4

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.4.
  2. The change lies in allowing empty answers in the free-form questions in the questionnaire. The feature does not break syntax of the previous version of the definition.
  3. Skip the change.

0.24.4 to 0.24.5

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.5.
  2. The change lies in adding an option to specify a whitelist for file types uploaded during the exercise. This feature also comes with a default whitelist. Please verify that the whitelist is sufficient. If not, follow the documentation instructions; if yes, then proceed.
  3. Skip the change.

0.24.5 to 0.24.6

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.6.
  2. The change lies in adding multiple new fields in common definitions, which serve for LLM features. The feature does not break syntax of the previous version of the definition.
  3. Skip the change.

0.24.6 to 0.24.7

  1. In the CHANGELOG, find the first subsequent definition version to the current version, which is, in this case, 0.24.7.
  2. The change adds a feature allowing explicit feedback on questionnaire correctness. The feature does not break syntax of the previous version of the definition.
  3. Skip the change.

Note

The validation process does not allow fields other than those mentioned in definition documentation. Before proceeding, please check that no definition file has extra fields. If it has, remove it, or the validation will fail.

  • Create a new .zip archive and upload it to the IXP.
  • The upload process will check the definition for errors.

You have successfully upgraded the definition version.