Merge pull request #26 from saadmk11/release-type

Add Option to use Release Types (major, minor, patch) for Updates

Author: saadmk11

README.md

@@ -85,6 +85,12 @@ jobs:
           # [Optional] Use The Latest Release Tag/Commit SHA or Default Branch Commit SHA to update the actions
           # options: "release-tag" (default), "release-commit-sha", "default-branch-sha"'
           update_version_with: 'release-tag'
+          # [Optional] A comma separated string of release types (major, minor, patch) to use when updating the actions
+          # If not specified, all releases will be used
+          # By default, all (major, minor, patch) release types are used to update the actions
+          # Only applicable for `release-tag` and `release-commit-sha` update_version_with options
+          # options: "all" (default), "major", "minor", "patch"
+          release_types: 'all'
           # [Optional] A comma separated string (usernames) which denotes the users
           # that should be added as reviewers to the pull request
           pull_request_user_reviewers: "octocat, hubot, other_user"

action.yaml

@@ -36,6 +36,10 @@ inputs:
     description: 'Use Latest Release Tag/Commit SHA or Default Branch Commit SHA to update. options: "release-tag" (default), "release-commit-sha", "default-branch-sha"'
     required: false
     default: 'release-tag'
+  release_types:
+    description: 'A comma separated string of release types (major, minor, patch) to use when updating the actions. If not specified, all releases will be used. options: "all" (default), "major", "minor", "patch"'
+    required: false
+    default: 'all'
   pull_request_user_reviewers:
     description: 'A comma separated string (usernames) which denotes the users that should be added as reviewers to the pull request'
     required: false

requirements.txt

@@ -1,3 +1,4 @@
 PyYAML~=6.0.0
+packaging~=21.3
 requests~=2.28.1
 github-action-utils~=1.0.2

src/config.py

@@ -14,6 +14,12 @@
     DEFAULT_BRANCH_COMMIT_SHA,
 ]
 
+MAJOR_RELEASE = "major"
+MINOR_RELEASE = "minor"
+PATCH_RELEASE = "patch"
+
+ALL_RELEASE_TYPES = [MAJOR_RELEASE, MINOR_RELEASE, PATCH_RELEASE]
+
 
 class ActionEnvironment(NamedTuple):
     repository: str
@@ -42,6 +48,7 @@ class Configuration(NamedTuple):
     update_version_with: str = LATEST_RELEASE_TAG
     pull_request_user_reviewers: set[str] = set()
     pull_request_team_reviewers: set[str] = set()
+    release_types: list[str] = ALL_RELEASE_TYPES
 
     @property
     def git_commit_author(self) -> str:
@@ -72,6 +79,7 @@ def get_user_config(cls, env: Mapping[str, str | None]) -> dict[str, str | None]
             "commit_message": env.get("INPUT_COMMIT_MESSAGE"),
             "ignore_actions": env.get("INPUT_IGNORE"),
             "update_version_with": env.get("INPUT_UPDATE_VERSION_WITH"),
+            "release_types": env.get("INPUT_RELEASE_TYPES"),
             "pull_request_user_reviewers": env.get("INPUT_PULL_REQUEST_USER_REVIEWERS"),
             "pull_request_team_reviewers": env.get("INPUT_PULL_REQUEST_TEAM_REVIEWERS"),
         }
@@ -122,6 +130,22 @@ def clean_pull_request_team_reviewers(value: Any) -> set[str] | None:
             return {s.strip() for s in value.strip().split(",") if s}
         return None
 
+    @staticmethod
+    def clean_release_types(value: Any) -> list[str] | None:
+        if value and isinstance(value, str):
+            values = [s.strip() for s in value.lower().strip().split(",") if s]
+            if values == ["all"]:
+                return ALL_RELEASE_TYPES
+            elif all(i in ALL_RELEASE_TYPES for i in values):
+                return values
+            else:
+                gha_utils.error(
+                    "Invalid input for `release_types` field, "
+                    f"expected one/all of {ALL_RELEASE_TYPES} but got `{value}`"
+                )
+                raise SystemExit(1)
+        return None
+
     @staticmethod
     def clean_skip_pull_request(value: Any) -> bool | None:
         if value in [1, "1", True, "true", "True"]: