Add user tagging, add env var option for token and dry_run

Author: beyhan

.github/workflows/org-inactive-user-management.yml

@@ -19,7 +19,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r community/org/requirements.txt
-          python community/org/org_user_management.py -gt ${{ secrets.GH_TOKEN }}
+          python community/org/org_user_management.py
       - name: Create Pull Request
         if: ${{ steps.uds.outputs.inactive_users_pr_description }}
         uses: peter-evans/create-pull-request@v4

org/org_user_management.py

@@ -95,7 +95,7 @@ def delete_inactive_contributors(self, users_to_delete):
         contributors_yaml["contributors"] = [c for c in contributors_yaml["contributors"] if c not in users_to_delete]
         self._write_yaml_file(path, contributors_yaml)
 
-    def get_inactive_users_msg(self, users_to_delete):
+    def get_inactive_users_msg(self, users_to_delete, tagusers):
         rfc = (
             "https://github.com/cloudfoundry/community/blob/main/toc/rfc/"
             "rfc-0025-define-criteria-and-removal-process-for-inactive-members.md"
@@ -104,23 +104,41 @@ def get_inactive_users_msg(self, users_to_delete):
             "https://github.com/cloudfoundry/community/blob/main/toc/rfc/rfc-0025-define-"
             "criteria-and-removal-process-for-inactive-members.md#remove-the-membership-to-the-cloud-foundry-github-organization"
         )
-        users_as_list = "\n".join(str(s) for s in users_to_delete)
+        user_tagging_prefix = "@" if tagusers else ""
+        users_as_list = "\n".join(str(user_tagging_prefix + s) for s in users_to_delete)
         return (
             f"According to the rolues for inactivity defined in [RFC-0025]({rfc}) following users will be deleted:\n"
             f"{users_as_list}\nAccording to the [revocation policy in the RFC]({rfc_revocation_rules}), users have"
             " two weeks to refute this revocation, if they wish."
         )
 
+    @staticmethod
+    def _get_bool_env_var(env_var_name, default):
+        return os.getenv(env_var_name, default).lower() == "true"
+
 
 if __name__ == "__main__":
     one_year_back = (datetime.datetime.now() - datetime.timedelta(days=365)).strftime("%Y-%m-%dT%H:%M:%SZ")
 
     parser = argparse.ArgumentParser(description="Cloud Foundry Org Inactive User Handler")
     parser.add_argument("-goid", "--githuborgid", default="O_kgDOAAl8sg", help="Cloud Foundry Github org ID")
     parser.add_argument("-go", "--githuborg", default="cloudfoundry", help="Cloud Foundry Github org name")
-    parser.add_argument("-sd", "--sincedate", default=one_year_back, help="Since when to analyze in format '%Y-%m-%dT%H:%M:%SZ'")
-    parser.add_argument("-gt", "--githubtoken", default="", help="Github API access token")
-    parser.add_argument("-dr", "--dryrun", default=False, help="Dry run execution")
+    parser.add_argument("-sd", "--sincedate", default=one_year_back, help="Since when to analyze in format 'Y-m-dTH:M:SZ'")
+    parser.add_argument(
+        "-gt", "--githubtoken", default=os.environ.get("GH_TOKEN"), help="Github API access token. Supported also as env var 'GH_TOKEN'"
+    )
+    parser.add_argument(
+        "-dr",
+        "--dryrun",
+        default=InactiveUserHandler._get_bool_env_var("INACTIVE_USER_MANAGEMENT_DRY_RUN", "False"),
+        help="Dry run execution. Supported also as env var 'INACTIVE_USER_MANAGEMENT_DRY_RUN'",
+    )
+    parser.add_argument(
+        "-tu",
+        "--tagusers",
+        default=InactiveUserHandler._get_bool_env_var("INACTIVE_USER_MANAGEMENT_TAG_USERS", "True"),
+        help="Tag users to be notified. Supported also as env var 'INACTIVE_USER_MANAGEMENT_TAG_USERS'",
+    )
     args = parser.parse_args()
 
     print("Get information about community users")
@@ -134,7 +152,7 @@ def get_inactive_users_msg(self, users_to_delete):
 
     print(f"Inactive users length is {len(inactive_users)} and inactive users are {inactive_users}")
     users_to_delete = inactive_users - community_members_with_role
-    inactive_users_msg = userHandler.get_inactive_users_msg(users_to_delete)
+    inactive_users_msg = userHandler.get_inactive_users_msg(users_to_delete, args.tagusers)
     if args.dryrun:
         print(f"Dry-run mode.\nInactive_users_msg is: {inactive_users_msg}")
         print(f"Following users will be deleted: {inactive_users}")

org/readme.md

@@ -87,6 +87,7 @@ How to run locally:
 cd ./org
 pip install -r requirements.txt
 python -m org_management --help
+python -m org_user_management --help
 ```
 
 Usage:
@@ -103,6 +104,28 @@ optional arguments:
                         output file for generated branch protection rules
 ```
 
+```
+python -m org_user_management --help
+usage: org_user_management.py [-h] [-goid GITHUBORGID] [-go GITHUBORG] [-sd SINCEDATE] [-gt GITHUBTOKEN] [-dr DRYRUN] [-tu TAGUSERS]
+
+Cloud Foundry Org Inactive User Handler
+
+options:
+  -h, --help            show this help message and exit
+  -goid GITHUBORGID, --githuborgid GITHUBORGID
+                        Cloud Foundry Github org ID
+  -go GITHUBORG, --githuborg GITHUBORG
+                        Cloud Foundry Github org name
+  -sd SINCEDATE, --sincedate SINCEDATE
+                        Since when to analyze in format 'Y-m-dTH:M:SZ'
+  -gt GITHUBTOKEN, --githubtoken GITHUBTOKEN
+                        Github API access token. Supported also as env var 'GH_TOKEN'
+  -dr DRYRUN, --dryrun DRYRUN
+                        Dry run execution. Supported also as env var 'INACTIVE_USER_MANAGEMENT_DRY_RUN'
+  -tu TAGUSERS, --tagusers TAGUSERS
+                        Tag users to be notified. Supported also as env var 'INACTIVE_USER_MANAGEMENT_TAG_USERS'
+```
+
 How to run tests:
 ```
 cd ./org