Class ::github::ActivityMonitor

::github::ActivityMonitor[i] create ... \
           [ -api_base (default "https://api.github.com") ] \
           [ -api_token api_token ] \
           [ -organization (default "OpenACS") ]

Defined in packages/xowiki/tcl/github-activity-monitor-procs.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nx::Object[i]

Methods (to be applied on instances)

  • backfill_repo_history (scripted, public)

     <instance of github::ActivityMonitor[i]> backfill_repo_history \
        [ -repo repo ] [ -branch branch ] [ -start_page start_page ] \
        [ -max_pages max_pages ]

    Backfill commit history for a single repo/branch using /repos/{repo}/commits. Uses synthetic negative event_id values. repo e.g. "openacs/openacs-core" branch e.g. "main" or "oacs-5-10"

    Switches:
    -repo (optional)
    -branch (optional, defaults to "main")
    -start_page (optional, defaults to "1")
    -max_pages (optional, defaults to "50")

    Testcases:
    No testcase defined.
  • get (scripted, public)

     <instance of github::ActivityMonitor[i]> get path [ query_args ]

    Issue an API call on GitHub for the configured organization.

    Parameters:
    path (required)
    query_args (optional)

    Testcases:
    No testcase defined.
  • summarize_push_event (scripted, public)

     <instance of github::ActivityMonitor[i]> summarize_push_event ev

    Fetch commit details and build a summary for PushEvents.

    Parameters:
    ev (required)
    Returns:
    dict with fields of push event

    Testcases:
    No testcase defined.
  • sync_from_github (scripted, public)

     <instance of github::ActivityMonitor[i]> sync_from_github

    Sync events from github: fetch, summarize, insert

    Testcases:
    No testcase defined.