Merge branch 'main' into feature-vrf-af

.flake8

@@ -0,0 +1,67 @@
+[flake8]
+
+builtins = _
+
+# Print the total number of errors:
+count = true
+
+# Don't even try to analyze these:
+extend-exclude =
+  # No need to traverse egg info dir
+  *.egg-info,
+  # tool cache dirs
+  *_cache
+  # project env vars
+  .env,
+  # GitHub configs
+  .github,
+  # Cache files of MyPy
+  .mypy_cache,
+  # Cache files of pytest
+  .pytest_cache,
+  # Temp dir of pytest-testmon
+  .tmontmp,
+  # Occasional virtualenv dir
+  .venv
+  # VS Code
+  .vscode,
+  # Temporary build dir
+  build,
+  # This contains sdists and wheels of ansible-navigator that we don't want to check
+  dist,
+  # Metadata of `pip wheel` cmd is autogenerated
+  pip-wheel-metadata,
+  # adjacent venv
+  venv
+  # ansible won't let me
+  __init__.py
+
+# IMPORTANT: avoid using ignore option, always use extend-ignore instead
+# Completely and unconditionally ignore the following errors:
+extend-ignore =
+  F841,
+  # line-length
+  E501,
+  # module level import not at top of file
+  E402
+
+# Accessibility/large fonts and PEP8 unfriendly:
+max-line-length = 120
+
+# Allow certain violations in certain files:
+# Please keep both sections of this list sorted, as it will be easier for others to find and add entries in the future
+per-file-ignores =
+  # The following ignores have been researched and should be considered permanent
+  # each should be preceeded with an explanation of each of the error codes
+  # If other ignores are added for a specific file in the section following this,
+  # these will need to be added to that line as well.
+
+
+   # S101: Allow the use of assert within the tests directory, since tests require it.
+  tests/**.py: S101
+
+  # The following were present during the initial implementation.
+  # They are expected to be fixed and unignored over time.
+
+# Count the number of occurrences of each error/warning code and print a report:
+statistics = true

.github/workflows/tests.yml

@@ -16,6 +16,8 @@ jobs:
   changelog:
     uses: ansible/ansible-content-actions/.github/workflows/changelog.yaml@main
     if: github.event_name == 'pull_request'
+  build-import:
+    uses: ansible/ansible-content-actions/.github/workflows/build_import.yaml@main
   ansible-lint:
     uses: ansible/ansible-content-actions/.github/workflows/ansible_lint.yaml@main
   sanity:
@@ -32,6 +34,7 @@ jobs:
     if: ${{ always() }}
     needs:
       - changelog
+      - build-import
       - sanity
       - unit-galaxy
       - ansible-lint

.pre-commit-config.yaml

@@ -1,13 +1,18 @@
 ---
+ci:
+  # format compatible with commitlint
+  autoupdate_commit_msg: "chore: pre-commit autoupdate"
+  autoupdate_schedule: monthly
+  autofix_commit_msg: "chore: auto fixes from pre-commit.com hooks"
+
 repos:
   - repo: https://github.com/ansible-network/collection_prep
     rev: 1.1.1
     hooks:
-      # - id: autoversion   # removed as being handled by GHA push and release drafter
       - id: update-docs
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: check-merge-conflict
       - id: check-symlinks
@@ -23,7 +28,7 @@ repos:
       - id: add-trailing-comma
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.0.3"
+    rev: "v4.0.0-alpha.8"
     hooks:
       - id: prettier
         entry: env CI=1 bash -c "prettier --list-different . || ec=$? && prettier --loglevel=error --write . && exit $ec"
@@ -34,13 +39,18 @@ repos:
           - prettier-plugin-toml
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         name: Sort import statements using isort
         args: ["--filter-files"]
 
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.4.2
     hooks:
       - id: black
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8

CHANGELOG.rst

@@ -4,6 +4,38 @@ Cisco Iosxr Collection Release Notes
 
 .. contents:: Topics
 
+v10.0.0
+=======
+
+Release Summary
+---------------
+
+Starting from this release, the minimum `ansible-core` version this collection requires is `2.15.0`. The last known version compatible with ansible-core<2.14 is `v9.0.0`. A new resource module `iosxr_vrf_global` is added to manage VRF global configurations.
+
+Major Changes
+-------------
+
+- Bumping `requires_ansible` to `>=2.15.0`, since previous ansible-core versions are EoL now.
+
+Minor Changes
+-------------
+
+- Adds a new module `iosxr_vrf_global` to manage VRF global configurations on Cisco IOS-XR devices (https://github.com/ansible-collections/cisco.iosxr/pull/467).
+
+v9.0.0
+======
+
+Major Changes
+-------------
+
+- Update the netcommon base version to support cli_restore plugin.
+
+Minor Changes
+-------------
+
+- Add support for cli_restore functionality.
+- Please refer the PR to know more about core changes (https://github.com/ansible-collections/ansible.netcommon/pull/618).
+- cli_restore module is part of netcommon.
 
 v8.0.0
 ======
@@ -370,7 +402,7 @@ Minor Changes
 New Modules
 -----------
 
-- iosxr_hostname - Manages hostname resource module
+- iosxr_hostname - Resource module to configure hostname.
 
 v2.6.0
 ======
@@ -395,7 +427,7 @@ Documentation Changes
 New Modules
 -----------
 
-- iosxr_snmp_server - Manages snmp-server resource module
+- iosxr_snmp_server - Resource module to configure snmp server.
 
 v2.5.0
 ======
@@ -431,7 +463,7 @@ Bugfixes
 New Modules
 -----------
 
-- iosxr_logging_global - Manages logging attributes of Cisco IOSXR network devices
+- iosxr_logging_global - Resource module to configure logging.
 
 v2.3.0
 ======
@@ -453,7 +485,7 @@ Bugfixes
 New Modules
 -----------
 
-- iosxr_prefix_lists - Prefix-Lists resource module.
+- iosxr_prefix_lists - Resource module to configure prefix lists.
 
 v2.2.0
 ======
@@ -539,9 +571,9 @@ Bugfixes
 New Modules
 -----------
 
-- iosxr_bgp_address_family - Manages BGP Address Family resource module.
-- iosxr_bgp_global - Manages BGP global resource module.
-- iosxr_bgp_neighbor_address_family - Manages BGP neighbor address family resource module.
+- iosxr_bgp_address_family - Resource module to configure BGP Address family.
+- iosxr_bgp_global - Resource module to configure BGP.
+- iosxr_bgp_neighbor_address_family - Resource module to configure BGP Neighbor Address family.
 
 v1.2.1
 ======
@@ -569,7 +601,7 @@ Bugfixes
 New Modules
 -----------
 
-- iosxr_ospf_interfaces - OSPF Interfaces Resource Module.
+- iosxr_ospf_interfaces - Resource module to configure OSPF interfaces.
 
 v1.1.0
 ======
@@ -583,7 +615,7 @@ Minor Changes
 New Modules
 -----------
 
-- iosxr_ospfv3 - ospfv3 resource module
+- iosxr_ospfv3 - Resource module to configure OSPFv3.
 
 v1.0.5
 ======
@@ -647,25 +679,22 @@ Netconf
 New Modules
 -----------
 
-- iosxr_acl_interfaces - ACL interfaces resource module
-- iosxr_acls - ACLs resource module
-- iosxr_banner - Manage multiline banners on Cisco IOS XR devices
-- iosxr_bgp - Configure global BGP protocol settings on Cisco IOS-XR
-- iosxr_command - Run commands on remote devices running Cisco IOS XR
-- iosxr_config - Manage Cisco IOS XR configuration sections
-- iosxr_facts - Get facts about iosxr devices.
-- iosxr_interface - (deprecated, removed after 2022-06-01) Manage Interface on Cisco IOS XR network devices
-- iosxr_interfaces - Interfaces resource module
-- iosxr_l2_interfaces - L2 interfaces resource module
-- iosxr_l3_interfaces - L3 interfaces resource module
-- iosxr_lacp - LACP resource module
-- iosxr_lacp_interfaces - LACP interfaces resource module
-- iosxr_lag_interfaces - LAG interfaces resource module
-- iosxr_lldp_global - LLDP resource module
-- iosxr_lldp_interfaces - LLDP interfaces resource module
-- iosxr_logging - Configuration management of system logging services on network devices
+- iosxr_acl_interfaces - Resource module to configure ACL interfaces.
+- iosxr_acls - Resource module to configure ACLs.
+- iosxr_banner - Module to configure multiline banners.
+- iosxr_command - Module to run commands on remote devices.
+- iosxr_config - Module to manage configuration sections.
+- iosxr_facts - Module to collect facts from remote devices.
+- iosxr_interfaces - Resource module to configure interfaces.
+- iosxr_l2_interfaces - Resource Module to configure L2 interfaces.
+- iosxr_l3_interfaces - Resource module to configure L3 interfaces.
+- iosxr_lacp - Resource module to configure LACP.
+- iosxr_lacp_interfaces - Resource module to configure LACP interfaces.
+- iosxr_lag_interfaces - Resource module to configure LAG interfaces.
+- iosxr_lldp_global - Resource module to configure LLDP.
+- iosxr_lldp_interfaces - Resource module to configure LLDP interfaces.
 - iosxr_netconf - Configures NetConf sub-system service on Cisco IOS-XR devices
-- iosxr_ospfv2 - OSPFv2 resource module
-- iosxr_static_routes - Static routes resource module
-- iosxr_system - Manage the system attributes on Cisco IOS XR devices
-- iosxr_user - Manage the aggregate of local users on Cisco IOS XR device
+- iosxr_ospfv2 - Resource module to configure OSPFv2.
+- iosxr_static_routes - Resource module to configure static routes.
+- iosxr_system - Module to manage the system attributes.
+- iosxr_user - Module to manage the aggregates of local users.

README.md

@@ -10,7 +10,7 @@ This collection has been tested against Cisco IOS-XR version 7.0.2
 <!--start requires_ansible-->
 ## Ansible version compatibility
 
-This collection has been tested against following Ansible versions: **>=2.14.0**.
+This collection has been tested against following Ansible versions: **>=2.15.0**.
 
 For collections that support Ansible 2.9, please ensure you update your `network_os` to use the
 fully qualified collection name (for example, `cisco.ios.ios`).
@@ -69,8 +69,7 @@ Name | Description
 [cisco.iosxr.iosxr_static_routes](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_static_routes_module.rst)|Resource module to configure static routes.
 [cisco.iosxr.iosxr_system](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_system_module.rst)|Module to manage the system attributes.
 [cisco.iosxr.iosxr_user](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_user_module.rst)|Module to manage the aggregates of local users.
-[cisco.iosxr.iosxr_vrf_address_family](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_vrf_address_family_module.rst)|Resource module to configure VRF Address family.
-[cisco.iosxr.iosxr_vrfs](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_vrfs_module.rst)|Manages global VRF configuration.
+[cisco.iosxr.iosxr_vrf_global](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_vrf_global_module.rst)|Manages global VRF configuration.
 
 <!--end collection content-->