Skip to content

CHANGELOG.md

Latest commit

 

History

History
253 lines (136 loc) · 8.57 KB

CHANGELOG.md

File metadata and controls

253 lines (136 loc) · 8.57 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v8.4.0 - (2026-01-19)

Added

  • Custom Headers: Webhook actions now support a headers dictionary in the trigger configuration, allowing for Authorization tokens and other custom metadata.
  • Data Unflattening: Introduced the unflatten_data setting. When enabled, flat data keys (e.g., user.profile.name) are expanded into nested JSON objects before the POST request.
  • Course Context: Added the use_course_information flag to automatically inject course data into the webhook payload during certificate events.
  • New Utility: Added unflatten_dict in eox_hooks.utils to handle complex dictionary expansions.

Changed

  • Refactoring: Certificate retrieval logic in post_to_webhook_url was moved to a dedicated get_certificate function for better maintainability.
  • Webhook Payload: The post request now defaults to json=data when unflatten_data is active, improving compatibility with modern API endpoints.

v8.3.0 - (2025-10-13)

Changed

  • Ulmo Support: Upgrade requirements base on edx-platform Ulmo release, update GitHub Workflows with new actions version.

v8.2.0 - (2025-07-01)

Added

  • Integration tests now run against Tutor Teak (<21.0.0) instead of Redwood (<19.0.0), keeping CI aligned with currently supported Open edX releases.

v8.1.0 - (2025-06-09)

Changed

  • Teak Support: Upgrade requirements base on edx-platform Teak

v8.0.0 - (2024-12-13)

Changed

  • Sumac Support: Removed support for Python 3.8. Upgrade requirements base on edx-platform Sumac release update GitHub workflows and actions version, and update integration test to use new Sumac release with Tutor.

v7.0.0 - (2024-11-20)

⚠ BREAKING CHANGES

  • Dropped Support for Django 3.2: Removed support for Django 3.2 in this plugin. As a result, we have also dropped support for Open edX releases from Maple up to and including Palm, which rely on Django 3.2. Future versions of this plugin may not be compatible with these Open edX releases.

v6.3.0 - (2024-07-24)

Added

  • Integration Tests: A new GitHub workflow has been added to run integration tests. These tests validate backend imports and ensure the /eox-info endpoint functions correctly.

Changed

  • Redwood Support: Upgrade requirements base on edx-platform redwood release update GitHub workflows with new Python (3.10 and 3.11) and actions version, and update integration test to use new redwood release with Tutor.

v6.2.0 - 2024-05-24

6.2.0 (2024-05-24)

Features

v6.1.0 - 2024-03-19

6.1.0 (2024-03-19)

Features

  • add workflow to add items to the Dedalo project DS-831 (#49) (54c66db)

v6.0.0 - 2024-02-09

6.0.0 (2024-02-09)

⚠ BREAKING CHANGES

  • Quince release support

  • fix(import): update URLs in favor of re_path for deprecation

  • perf: update requirements

  • fix: remove 3.10 version test

  • perf: update workflows and readme

  • fix: fix AttributeError to non-string uid

  • perf: update tests

  • perf: update codelytv/pr-size-labeler

  • perf: add django32, django42 file requirements

  • perf: update Django version constrain

  • fix: update python test version

  • perf: update readme and constraints

  • perf: update constraints

  • perf: update requirements

  • perf: update tox

  • fix: update actions/setup-python version

  • perf: quince release support (#48) (3a330d7), closes #48

v5.1.0 - 2023-11-24

5.1.0 (2023-11-24)

Features

v5.0.0 - 2023-11-20

5.0.0 (2023-11-20)

⚠ BREAKING CHANGES

  • add palm support

Performance Improvements

v4.1.1 - 2023-06-21

4.1.1 (2023-06-21)

Bug Fixes

  • valitade enrollment for programs (#42) (c4711a9)

v4.1.0 - 2023-05-10

4.1.0 (2023-05-10)

Features

  • allow a child course to belong to multiples parents (#41) (1bb9700)

Continuous Integration

v4.0.0 - 2023-01-30

4.0.0 (2023-01-30)

⚠ BREAKING CHANGES

  • DS-367: add compatibility with olive

Features

  • DS-367: add compatibility with Open edX olive release (#39) (887bf2c)

v3.0.1 - 2023-01-10

3.0.1 (2023-01-10)

Bug Fixes

  • adding a fake request to execute in async servers (#35) (0fbf12e)

Continuous Integration

  • adds mantainer group (#37) (b8c8596)
  • update the changelog updater step in bumpversion (#36) (563dd82)

v3.0.0 - 2022-10-06

3.0.0 (2022-10-06)

⚠ BREAKING CHANGES

  • Drop python 3.5 support in favor of python 3.8.

Features

[2.0.1] - 2022-06-28

Added

  • Add more descriptive message when action fails.

[2.0.0] - 2021-11-17

Added

  • BREAKING CHANGE: add support for lilac and therefore changed backends defaults.
  • BREAKING CHANGE: add support for openedx-events. Only works for Lilac with PRs backport 28266 and 18640
  • and >= Maple.

[1.0.0] - 2021-08-17

Added

  • Drop support for python 2.7.
  • Add backends for course, enrollment and course modes.
  • Add custom action and task used to enroll users into program courses.
  • Add action that propagates grade to course programs

[0.5.0] - 2021-04-13

Added

  • Added post_register signal configuration.

[0.4.0] - 2021-02-18

Added

  • Added post_to_webhook_url action.

[0.3.0] - 2020-11-11

Added

  • First release on PyPI.

[0.2.1] - 2020-10-29

Added

  • Allow install plugin without existent signal_paths.

[0.2.0] - 2020-08-04

Added

  • Added trigger/action handlers for defined hooks.

[0.1.0] - 2020-07-08