Merge pull request #232 from creativecommons/enable-workflows

Enable workflows

Author: TimidRobot

.github/workflows/enable_workflows.yml

@@ -0,0 +1,35 @@
+name: Enable workflows
+on:
+  schedule:
+    - cron: '22 22 1 * *' # Monthly on the 1st at 22:22
+  workflow_dispatch:
+
+jobs:
+  normalize_repos:
+    runs-on: ubuntu-latest
+    steps:
+
+    # https://github.com/actions/setup-python
+    - name: Setup Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - name: Install system dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pipenv
+
+    # https://github.com/actions/checkout
+    - uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+
+    - name: Install app dependencies
+      run: pipenv sync --system
+
+    - name: Run script with token in env
+      run: ./enable_workflows.py \
+        ccos_scripts
+      env:
+        ADMIN_GITHUB_TOKEN: ${{ secrets.ADMIN_GITHUB_TOKEN }}

.github/workflows/normalize_repos.yml

@@ -39,10 +39,3 @@ jobs:
       with:
         name: invalid-issue-report
         path: /tmp/invalid_issues.yml
-
-#    # https://github.com/gautamkrishnar/keepalive-workflow
-#    - uses: gautamkrishnar/keepalive-workflow@v2
-#      with:
-#        committer_username: cc-open-source-bot
-#        committer_email: opensource@creativecommons.org
-#        time_elapsed: 46

README.md

@@ -10,6 +10,7 @@ infrastructure.
 - [![Manage issues and pull requests in projects][issues_badge]][issues_link]
 - [![Normalize Repos][norm_badge]][norm_link]
 - [![Push data to CC Open Source][data_badge]][data_link]
+- [![Enable workflows][enable_badge]][enable_link]
 
 [teams_badge]: https://github.com/creativecommons/ccos-scripts/actions/workflows/sync_community_teams.yml/badge.svg
 [teams_link]: #sync-community-teams-with-github
@@ -19,6 +20,8 @@ infrastructure.
 [norm_link]: #normalize-repos
 [data_badge]: https://github.com/creativecommons/ccos-scripts/actions/workflows/push_data_to_ccos.yml/badge.svg
 [data_link]: #push-data-to-cc-open-source
+[enable_badge]: https://github.com/creativecommons/ccos-scripts/actions/workflows/enable_workflows.yml/badge.svg
+[enable_link]: #enable-workflows
 
 
 ## Code of conduct
@@ -113,8 +116,6 @@ in a GitHub project:
 | | File: | [`normalize_repos.py`][norm_file] |
 | | Common Modules: | [`ccos/`](ccos/) |
 | | Specific Modules: | [`ccos/norm/`](ccos/norm/) |
-| **Action** | | |
-| | | [gautamkrishnar/keepalive-workflow][keepalive] |
 | **Env** | | |
 | | Required: | `ADMIN_GITHUB_TOKEN` |
 
@@ -128,7 +129,6 @@ new labels. It will never delete labels.
 
 [norm_pr_yml]: .github/workflows/normalize_repos.yml
 [norm_file]: normalize_repos.py
-[keepalive]: https://github.com/gautamkrishnar/keepalive-workflow
 
 
 ### Push data to CC Open Source
@@ -167,6 +167,28 @@ The destination data is used by the following pages:
 [db_repos]: https://github.com/creativecommons/ccos-website-source/blob/main/databags/repos.json
 
 
+### Eanble Workflows
+
+| **Workflow** | | |
+| -- | --: | --- |
+| | Schedule: | Monthly on the 1st at 22:22 |
+| | YAML: | [`enable_workflows.yml`][enable_workflows_yml] |
+| **Script** | | |
+| | File: | [`enable_workflows.py`][enable_workflows_file] |
+| | Common Modules: | [`ccos/`](ccos/) |
+| **Env** | | |
+| | Required: | `ADMIN_GITHUB_TOKEN` |
+
+Enable GitHub Action workflows for specified repositories (ensures that they
+are not disabled due to inactivity).
+
+For more information, see [Prevent scheduled GitHub Actions from becoming disabled - Stack Overflow][prevent_scheduled].
+
+[enable_workflows_yml]: .github/workflows/enable_workflows.yml
+[enable_workflows_file]: enable_workflows.py
+[prevent_scheduled]: https://stackoverflow.com/questions/67184368/prevent-scheduled-github-actions-from-becoming-disabled
+
+
 ## Environment Variables
 
 - `ADMIN_ASANA_TOKEN`: Asana token with access to the Creative Commons Asana

enable_workflows.py

@@ -0,0 +1,98 @@
+#!/usr/bin/env python3
+# vim: set fileencoding=utf-8:
+"""
+Enable GitHub Action workflows for specified repositories (ensures that they
+are not disabled due to inactivity).
+"""
+
+# Standard library
+import argparse
+import sys
+import traceback
+
+# First-party/Local
+import ccos.log
+from ccos import gh_utils
+
+LOG = ccos.log.setup_logger()
+
+
+class ScriptError(Exception):
+    def __init__(self, message, code=None):
+        self.code = code if code else 1
+        message = "({}) {}".format(self.code, message)
+        super(ScriptError, self).__init__(message)
+
+
+def setup():
+    """
+    Instantiate and configure argparse and logging.
+
+    Return argsparse namespace.
+    """
+    ap = argparse.ArgumentParser(description=__doc__)
+    ap.add_argument(
+        "-n",
+        "--dryrun",
+        action="store_true",
+        help="dry run: do not make any changes",
+    )
+    ap.add_argument(
+        "repos",
+        nargs="*",
+        help="repository to act on (multiple repositories may be specified)",
+        metavar="REPOSITORY",
+    )
+    args = ap.parse_args()
+    if args.dryrun:
+        args.dryrun = "dryrun (no-op): "
+    else:
+        args.dryrun = ""
+    if not args.repos:
+        raise ap.error("at least one (1) REPOSITORY must be specified")
+    return args
+
+
+def get_workflows(args, repos):
+    workflows = []
+    for repo in repos:
+        for workflow in repo.get_workflows():
+            workflow.repo_name = repo.name
+            workflows.append(workflow)
+    return workflows
+
+
+def enable_workflows(args, workflows):
+    for workflow in workflows:
+        LOG.info(
+            f"{args.dryrun}Enabling {workflow.repo_name}:"
+            f' "{workflow.name}"'
+        )
+        if not args.dryrun:
+            workflow.enable()
+
+
+def main():
+    args = setup()
+    github_client = gh_utils.setup_github_rest_client()
+    gh_org_cc = gh_utils.get_cc_organization(github_client)
+    repos = gh_utils.get_select_repos(args, gh_org_cc)
+    workflows = get_workflows(args, repos)
+    enable_workflows(args, workflows)
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except SystemExit as e:
+        sys.exit(e.code)
+    except KeyboardInterrupt:
+        LOG.info("Halted via KeyboardInterrupt.")
+        sys.exit(130)
+    except ScriptError:
+        error_type, error_value, error_traceback = sys.exc_info()
+        LOG.critical(f"{error_value}")
+        sys.exit(error_value.code)
+    except Exception:
+        LOG.error(f"Unhandled exception: {traceback.format_exc()}")
+        sys.exit(1)

normalize_repos.py

@@ -110,7 +110,7 @@ def update_branch_protection(repo):
     config = load_branch_protection_config()
     exempt_repositories = config["EXEMPT_REPOSITORIES"]
     required_status_check_map = config["REQUIRED_STATUS_CHECK_MAP"]
-    
+
     exempt_users = config.get("EXEMPT_USERS", {}).get(repo.name, [])
 
     if repo.name not in exempt_repositories and is_engineering_project(repo):
@@ -143,7 +143,7 @@ def update_branch_protection(repo):
 def update_branches(args, repos):
     if args.skip_branches:
         return
-    
+
     LOG.info("Evaluting repositories for branch protections...")
     for repo in repos:
         update_branch_protection(repo)