add argument to update version in galaxy.yml file

changelogs/fragments/update_galaxy.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Add ``--update-galaxy-file`` option to the ``release`` command to update version in ``galaxy.yml`` file (https://github.com/ansible-community/antsibull-changelog/pull/127).

src/antsibull_changelog/cli.py

@@ -37,6 +37,7 @@
 from .logger import LOGGER, setup_logger
 from .plugins import PluginDescription, load_plugins
 from .toml import has_toml_loader_available, load_toml
+from .update_galaxy import update_galaxy
 
 
 def set_paths(
@@ -239,6 +240,12 @@ def create_argparser(program_name: str) -> argparse.ArgumentParser:
     release_parser.set_defaults(func=command_release)
     release_parser.add_argument("--version", help="override release version")
     release_parser.add_argument("--codename", help="override/set release codename")
+    release_parser.add_argument(
+        "--update-galaxy-file",
+        action="store_true",
+        help="re-write galaxy.yml with the supplied version. "
+        "Note that this will remove comments and formatting",
+    )
     release_parser.add_argument(
         "--date", default=str(datetime.date.today()), help="override release date"
     )
@@ -610,6 +617,12 @@ def command_release(args: Any) -> int:
         paths, config, collection_details, args
     )
 
+    if args.update_galaxy_file:
+        if not paths.galaxy_path:
+            LOGGER.error("Cannot find galaxy.yml file in path.")
+        else:
+            update_galaxy(galaxy_path=paths.galaxy_path, version=version)
+
     changes = load_changes(config)
 
     prev_version: str | None = None

src/antsibull_changelog/update_galaxy.py

@@ -0,0 +1,34 @@
+# Author: Sagar Paul <paul.sagar@yahoo.com>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
+# https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2023, Ansible Project
+
+"""
+Update the galaxy the yaml file.
+"""
+
+from __future__ import annotations
+
+# from typing import TYPE_CHECKING
+
+from .logger import LOGGER
+from .yaml import load_yaml, store_yaml
+
+# if TYPE_CHECKING:
+#     from _typeshed import StrOrBytesPath
+
+
+def update_galaxy(galaxy_path: str, version: str) -> None:
+    """
+    Load and update galaxy.yaml file.
+    """
+    try:
+        config = load_yaml(galaxy_path)
+
+        if config["version"] != version:
+            config["version"] = version
+            store_yaml(galaxy_path, config)
+
+    except Exception:  # pylint: disable=broad-except
+        LOGGER.error("Unable to load the galaxy.yml file.")

tests/units/fixtures/galaxy.yml

@@ -0,0 +1,15 @@
+authors:
+  - Ansible Bot (ansibuddy)
+dependencies:
+  ansible.netcommon: ">=2.5.1"
+description: Test dummy collection
+issues: https://github.com/ansible-collections/test.dummy/issues
+license_file: LICENSE
+name: dummy
+namespace: test
+readme: README.md
+repository: https://github.com/ansible-collections/test.dummy
+tags:
+  - test
+  - dummy
+version: 2.0.0