Update changelog validation action (#151)

Author: abikouo

.github/actions/ansible_validate_changelog/action.yml

@@ -11,6 +11,11 @@ inputs:
     description: The pull request base ref.
     required: false
     default: ${{ github.event.pull_request.base.ref }}
+  custom_paths:
+    description: |
+      A comma-separated list of custom paths from which any modified file
+      will require a changelog.
+    default: ""
 
 runs:
   using: composite
@@ -29,5 +34,6 @@ runs:
       run: >-
         python3 ${{ github.action_path }}/validate_changelog.py
         --ref ${{ inputs.base_ref }}
+        --custom-paths ${{ inputs.custom_paths }}
       shell: bash
       working-directory: ${{ inputs.path }}

.github/actions/ansible_validate_changelog/validate_changelog.py

@@ -9,6 +9,7 @@
 
 from collections import defaultdict
 from pathlib import Path
+from typing import Optional
 
 import yaml
 
@@ -71,6 +72,7 @@ def is_documentation_file(ref: str) -> bool:
     prefix_list = (
         "docs/",
         "plugins/doc_fragments",
+        "examples",
     )
     return ref.startswith(prefix_list)
 
@@ -96,10 +98,11 @@ def is_release_pr(changes: dict[str, list[str]]) -> bool:
     return True
 
 
-def is_changelog_needed(changes: dict[str, list[str]]) -> bool:
+def is_changelog_needed(changes: dict[str, list[str]], custom_paths: Optional[list[str]]) -> bool:
     """Determine whether a changelog fragment is necessary.
 
     :param changes: A dictionary keyed on change status (A, M, D, etc.) of lists of changed files
+    :param custom_paths: additional paths to check changes in
     :returns: True if a changelog fragment is not required for this PR else False
     """
     # Changes to existing plugins or modules require a changelog
@@ -108,6 +111,11 @@ def is_changelog_needed(changes: dict[str, list[str]]) -> bool:
     modifications = changes["M"] + changes["D"]
     if any(is_module_or_plugin(x) for x in modifications):
         return True
+    # check any file from the custom paths
+    if custom_paths:
+        for ref in modifications + changes["A"]:
+            if any(ref.startswith(x) for x in custom_paths):
+                return True
 
     return False
 
@@ -205,10 +213,11 @@ def list_files(ref: str) -> dict[str, list[str]]:
     return changes
 
 
-def main(ref: str) -> None:
+def main(ref: str, custom_paths: Optional[list[str]]) -> None:
     """Run the script.
 
     :param ref: The pull request base ref
+    :param custom_paths: additional paths to check changes in
     """
     changes = list_files(ref)
     if changes:
@@ -219,7 +228,7 @@ def main(ref: str) -> None:
         changelog = [x for x in changes["A"] if is_changelog_file(x)]
         logger.info("changelog files -> %s", changelog)
         if not changelog:
-            if is_changelog_needed(changes):
+            if is_changelog_needed(changes, custom_paths):
                 logger.error(
                     "Missing changelog fragment. This is not required"
                     " only if PR adds new modules and plugins or contain"
@@ -241,9 +250,19 @@ def main(ref: str) -> None:
     sys.exit(0)
 
 
+def comma_separated_list(arg: str) -> list[str]:
+    """Parse a string into a list of string.
+
+    :param arg: The string list to parse
+    :returns: A list of string
+    """
+    return [x for x in arg.split(",") if x]
+
+
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Validate changelog file from new commit")
     parser.add_argument("--ref", required=True, help="Pull request base ref")
+    parser.add_argument("--custom-paths", type=comma_separated_list)
 
     args = parser.parse_args()
-    main(args.ref)
+    main(args.ref, args.custom_paths)

.github/workflows/changelog.yml

@@ -1,6 +1,14 @@
 name: Changelog required
 on:
   workflow_call:
+    inputs:
+      custom_paths:
+        description: |
+          A comma-separated list of custom paths from which any modified file
+          will require a changelog.
+        required: false
+        type: string
+        default: ""
 jobs:
   changelog:
     runs-on: ubuntu-latest
@@ -15,3 +23,5 @@ jobs:
 
       - name: Validate changelog
         uses: ansible-network/github_actions/.github/actions/ansible_validate_changelog@main
+        with:
+          custom_paths: ${{ inputs.custom_paths }}