Skip to content

Commit

Permalink
chore: add migration guide for breaking change to get_ancestors
Browse files Browse the repository at this point in the history
  • Loading branch information
bhearsum committed Jan 23, 2025
1 parent 10a0dcd commit b72ce3a
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/reference/migrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@ Migration Guide

This page can help when migrating Taskgraph across major versions.

12.x -> 13.x
------------

* Invert any usage of the dict keys and values returned by `get_ancestors`:

For example, if you were using:

.. code-block:: python
for label, taskid in get_ancestors(...):
...
Change it to:

.. code-block:: python
for taskid, label in get_ancestors(...):
...
Note that due to this change `get_ancestors` may return multiple tasks with
the same label now, which your code may need to deal with.

11.x -> 12.x
------------

Expand Down

0 comments on commit b72ce3a

Please sign in to comment.