diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 297a040..4bbcbb1 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,5 +1,40 @@ -Will be updated by antsibull-changelog. Do not edit this manually! +====================================== +Ansible Utils Collection Release Notes +====================================== -See https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst for information on how to use antsibull-changelog. +.. contents:: Topics -Check out ``changelogs/config.yaml`` for its configuration. You need to change at least the ``title`` field in there. + +v1.0.0 +====== + +Minor Changes +------------- + +- Add cli_parse module and plugins (https://github.com/ansible-collections/ansible.utils/pull/28) +- Added fact_diff plugin and sub plugin +- Added validate module/lookup/filter/test plugin to validate data based on given criteria + +Bugfixes +-------- + +- linting and formatting for CI + +New Plugins +----------- + +Lookup +~~~~~~ + +- get_path - Retrieve the value in a variable using a path +- index_of - Find the indices of items in a list matching some criteria +- to_paths - Flatten a complex object into a dictionary of paths and values +- validate - Validate data with provided criteria + +New Modules +----------- + +- cli_parse - Parse cli output or text using a variety of parsers +- fact_diff - Find the difference between currently set facts +- update_fact - Update currently set facts +- validate - Validate data with provided criteria diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 2abdaca..9747375 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1 +1,46 @@ -releases: {} +ancestor: null +releases: + 1.0.0: + changes: + bugfixes: + - linting and formatting for CI + minor_changes: + - Add cli_parse module and plugins (https://github.com/ansible-collections/ansible.utils/pull/28) + - Added fact_diff plugin and sub plugin + - Added validate module/lookup/filter/test plugin to validate data based on + given criteria + fragments: + - 23 linting and formatting.yaml + - 28_cli_parse_plugins_add.yaml + - 29-add_docs_for_Cli_parse.yaml + - add_fact_diff.yaml + - docs_copyedit.yaml + - validate.yaml + modules: + - description: Parse cli output or text using a variety of parsers + name: cli_parse + namespace: '' + - description: Find the difference between currently set facts + name: fact_diff + namespace: '' + - description: Update currently set facts + name: update_fact + namespace: '' + - description: Validate data with provided criteria + name: validate + namespace: '' + plugins: + lookup: + - description: Retrieve the value in a variable using a path + name: get_path + namespace: null + - description: Find the indices of items in a list matching some criteria + name: index_of + namespace: null + - description: Flatten a complex object into a dictionary of paths and values + name: to_paths + namespace: null + - description: Validate data with provided criteria + name: validate + namespace: null + release_date: '2020-12-08' diff --git a/changelogs/fragments/23 linting and formatting.yaml b/changelogs/fragments/23 linting and formatting.yaml deleted file mode 100644 index 7b9d8c2..0000000 --- a/changelogs/fragments/23 linting and formatting.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - linting and formatting for CI diff --git a/changelogs/fragments/28_cli_parse_plugins_add.yaml b/changelogs/fragments/28_cli_parse_plugins_add.yaml deleted file mode 100644 index a5b2683..0000000 --- a/changelogs/fragments/28_cli_parse_plugins_add.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Add cli_parse module and plugins (https://github.com/ansible-collections/ansible.utils/pull/28) \ No newline at end of file diff --git a/changelogs/fragments/29-add_docs_for_Cli_parse.yaml b/changelogs/fragments/29-add_docs_for_Cli_parse.yaml deleted file mode 100644 index 867cf21..0000000 --- a/changelogs/fragments/29-add_docs_for_Cli_parse.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - Add docs for cli_parse and fact_diff (https://github.com/ansible-collections/ansible.utils/pull/29) diff --git a/changelogs/fragments/add_fact_diff.yaml b/changelogs/fragments/add_fact_diff.yaml deleted file mode 100644 index 94af7bb..0000000 --- a/changelogs/fragments/add_fact_diff.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Added fact_diff plugin and sub plugin diff --git a/changelogs/fragments/docs_copyedit.yaml b/changelogs/fragments/docs_copyedit.yaml deleted file mode 100644 index 14fec47..0000000 --- a/changelogs/fragments/docs_copyedit.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - Edited the documentation diff --git a/changelogs/fragments/validate.yaml b/changelogs/fragments/validate.yaml deleted file mode 100644 index 5a7307b..0000000 --- a/changelogs/fragments/validate.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Added validate module/lookup/filter/test plugin to validate data based on given criteria diff --git a/galaxy.yml b/galaxy.yml index aeaa9b1..2bd79a4 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -7,7 +7,7 @@ namespace: ansible description: Ansible Collection with utilities to ease the management, manipulation, and validation of data within a playbook readme: README.md repository: https://github.com/ansible-collections/ansible.utils -tags: [networking, security, cloud, utilities, data, validation] -# this will be updated by a gh action prior to push -# do not modify, see /github/workflows/publish.yml -version: 0.0.0 +tags: [linux, networking, security, cloud, utilities, data, validation, utils] +# NOTE(pabelanger): We create an empty version key to keep ansible-galaxy +# happy. We dynamically inject version info based on git information. +version: null