Doc: Deprecate the eos_designs and eos_cli_config_gen jsonschema.json… #4195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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-4195
# Activate the virtual environment
source test-avd-pr-4195/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/gmuloc/avd.git@chore-deprecate-avd-json-schemas#subdirectory=python-avd" --force
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/gmuloc/avd.git#/ansible_collections/arista/avd/,chore-deprecate-avd-json-schemas --force
# Optional: Install AVD examples
cd test-avd-pr-4195
ansible-playbook arista.avd.install_examples |
github-actions
bot
added
the
type: documentation
carlbuchmann
reviewed
Jul 9, 2024
| @@ -42,6 +42,8 @@ Pull request: | |||
| - AVD version 5.0.0 will drop support for Python version 3.9. The decision has been taken to remove Python version 3.9 support in AVD collection to anticipate its removal in `ansible-core`. | |||
| `ansible-core` version 2.15 End-Of-Life is scheduled for November 2024 and it will be the last `ansible-core` version supporting Python version 3.9 as documented here: https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix. | |||
|
|
|||
| - In AVD version 5.0.0, the `eos_designs.jsonschema.json` and `eos_cli_config_gen.jsonschema.json` will not be generated anymore. These schemas are not being used and have never been complete. | |||
There was a problem hiding this comment.
Suggested change
| - In AVD version 5.0.0, the `eos_designs.jsonschema.json` and `eos_cli_config_gen.jsonschema.json` will not be generated anymore. These schemas are not being used and have never been complete. | |
| - In AVD version 5.0.0, the `eos_designs.jsonschema.json` and `eos_cli_config_gen.jsonschema.json` will no longer be generated. These schemas are not being used and have never been completed. |
There was a problem hiding this comment.
This was added under 4.9.0, I'm thinking perhaps we need to move the Deprecations section at the top outside of a specific release with H2 heading?
There was a problem hiding this comment.
hmm indeed need to prepare for 4.10.x
good point
There was a problem hiding this comment.
I would keep complete instead of completed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Announce in the release notes that the
eos_cli_config_gen.jsonschema.jsonandeos_designs.jsonschema.jsonfiles won't be generated starting AVD 5.0.0Component(s) name
arista.avd.eos_designsarista.avd.eos_cli_config_genProposed changes
deprecation message in release_notes 4.x.x
How to test
no test
Checklist
Repository Checklist