Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor(eos_designs,eos_cli_config_gen): Deprecate type conversion from dict-of-dicts to list-of-dicts #4237

Conversation

ClausHolbechArista
Copy link
Contributor

@ClausHolbechArista ClausHolbechArista commented Jul 23, 2024

Change Summary

Deprecate type conversion from dict-of-dicts to list-of-dicts

As noted in release-notes for AVD 4.0.0 and in the porting guide for 3.x -> 4.x upgrades the automatic conversion of dict-of-dicts to list-of-dicts will be removed in AVD 5.0.

Component(s) name

arista.avd.eos_designs
arista.avd.eos_cli_config_gen

Proposed changes

Adding deprecation warning if any conversions are happening.

How to test

Tested by running molecule converge -s eos_designs_deprecated_vars

Proof:
https://github.com/aristanetworks/avd/actions/runs/10055082881/job/27790997106#step:6:297

Checklist

User Checklist

  • N/A

Repository Checklist

  • My code has been rebased from devel before I start
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation and documentation have been updated accordingly.
  • I have updated molecule CI testing accordingly. (check the box if not applicable)

@ClausHolbechArista ClausHolbechArista requested review from a team as code owners July 23, 2024 06:03
@ClausHolbechArista ClausHolbechArista changed the title Refactor(eos designs,eos_cli_config_gen): Deprecate type conversion from from dict-of-dicts to list-of-dicts Refactor(eos designs,eos_cli_config_gen): Deprecate type conversion from dict-of-dicts to list-of-dicts Jul 23, 2024
Copy link

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4237
# Activate the virtual environment
source test-avd-pr-4237/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/ClausHolbechArista/avd.git@refactor/eos_designs/deprecate-dict-conversion#subdirectory=python-avd" --force
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/ClausHolbechArista/avd.git#/ansible_collections/arista/avd/,refactor/eos_designs/deprecate-dict-conversion --force
# Optional: Install AVD examples
cd test-avd-pr-4237
ansible-playbook arista.avd.install_examples

@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Jul 23, 2024
@ClausHolbechArista ClausHolbechArista changed the title Refactor(eos designs,eos_cli_config_gen): Deprecate type conversion from dict-of-dicts to list-of-dicts Refactor(eos_designs,eos_cli_config_gen): Deprecate type conversion from dict-of-dicts to list-of-dicts Jul 23, 2024
Copy link
Contributor

@gmuloc gmuloc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL is broken in the deprecation warning ouptut but it would still take to the right place we probably can live with this.

Copy link

sonarcloud bot commented Jul 23, 2024

@gmuloc gmuloc merged commit 2320250 into aristanetworks:devel Jul 23, 2024
41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants