saltext.github 1.1.0__py3-none-any.whl

saltext/github/modules/github.py

@@ -0,0 +1,1873 @@
+"""
+General module for interacting with the GitHub v3 API.
+
+Contains functionality that is not tied to a single organization or
+repository, e.g. generic account lookups, the token's API rate limit
+status or direct queries against arbitrary API endpoints.
+
+:depends: PyGithub python module
+
+.. important::
+
+    All organization- and repository-related functions in this module are
+    deprecated in favor of the :py:mod:`github_org
+    <saltext.github.modules.github_org>` and :py:mod:`github_repo
+    <saltext.github.modules.github_repo>` modules, which raise errors
+    instead of logging and returning ``False``. The non-deprecated
+    functions in this module behave like the scoped modules in this
+    regard.
+
+Configuration
+-------------
+
+This module reads its configuration from profiles, which are described
+in the :ref:`configuration guide <github-configuration>`. All functions
+accept a ``profile`` argument, defaulting to the ``github`` profile.
+"""
+
+import logging
+
+from salt.exceptions import CommandExecutionError
+
+from saltext.github.utils import filter_unset
+
+try:
+    from saltext.github.utils.gh import client as gh_client
+    from saltext.github.utils.gh import issues as gh_issues
+    from saltext.github.utils.gh import members as gh_members
+    from saltext.github.utils.gh import milestones as gh_milestones
+    from saltext.github.utils.gh import profile as gh_profile
+    from saltext.github.utils.gh import pulls as gh_pulls
+    from saltext.github.utils.gh import repos as gh_repos
+    from saltext.github.utils.gh import rulesets as gh_rulesets
+    from saltext.github.utils.gh import teams as gh_teams
+    from saltext.github.utils.gh import users as gh_users
+    from saltext.github.utils.gh.exceptions import GitHubApiError
+    from saltext.github.utils.gh.exceptions import GitHubNotFoundError
+
+    HAS_LIBS = True
+except ImportError:  # pragma: no cover
+    HAS_LIBS = False
+
+log = logging.getLogger(__name__)
+
+__virtualname__ = "github"
+
+
+def __virtual__():
+    if HAS_LIBS:
+        return __virtualname__
+    return (  # pragma: no cover
+        False,
+        "The github execution module cannot be loaded: PyGithub library is not installed.",
+    )
+
+
+def _get_conn(profile):
+    """
+    Return the GitHub connection, cached into __context__ for performance
+    """
+    return gh_profile.get_conn(profile, opts=__opts__, context=__context__)
+
+
+def _get_conn_repo(profile, repo_name) -> tuple[object, str]:
+    return _get_conn(profile), repo_name or _get_config_value(profile, "repo_name")
+
+
+def _get_config_value(profile, config_name):
+    """
+    Helper function that returns a profile's configuration value based on
+    the supplied configuration name.
+
+    profile
+        The profile name that contains configuration information.
+
+    config_name
+        The configuration item's name to use to return configuration values.
+    """
+    return gh_profile.get_config_value(profile, config_name, opts=__opts__, context=__context__)
+
+
+def _get_owner(profile):
+    """
+    Helper function that returns a profile's default repository owner
+    (``owner``, legacy alias ``org_name``), or None when unset.
+    """
+    return gh_profile.get_owner(profile, opts=__opts__, context=__context__)
+
+
+def query(
+    path, params=None, method="GET", headers=None, data=None, per_page=None, profile="github"
+):
+    """
+    Make a direct call to the GitHub API, transparently following
+    pagination. Useful for endpoints without a dedicated wrapper function.
+
+    .. versionadded:: 1.1.0
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt-call github.query repos/saltstack/salt
+        salt-call github.query orgs/my-org/members per_page=100
+        salt-call github.query repos/my-org/my-repo/labels method=POST data='{name: bug}'
+
+    path
+        URL path to query, either as a string or a list of segments.
+
+    params
+        Mapping of query parameters.
+
+    method
+        HTTP method to use. Defaults to ``GET``.
+
+    headers
+        Mapping of extra headers to send.
+
+    data
+        Request body, either as a mapping or a JSON string.
+
+    per_page
+        Pagination size, maximum 100.
+
+    profile
+        Profile configuration name to use. Defaults to ``github``.
+
+    Returns the decoded response data. List results are merged across pages.
+    Raises :py:class:`CommandExecutionError <salt.exceptions.CommandExecutionError>`
+    subclasses on error responses.
+    """
+    if isinstance(path, str):
+        path = path.strip("/")
+    return _get_conn(profile).query(
+        path, params=params, method=method, headers=headers, data=data, per_page=per_page
+    )
+
+
+def rate_limit(profile="github"):
+    """
+    Return the API rate limit status of the profile's token, keyed by
+    resource (``core``, ``search``, ...).
+
+    .. versionadded:: 1.1.0
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt-call github.rate_limit
+
+    profile
+        Profile configuration name to use. Defaults to ``github``.
+    """
+    return gh_client.rate_limit(_get_conn(profile))
+
+
+def revoke_app_token(profile="github"):
+    """
+    Revoke the GitHub App installation access token the profile
+    currently authenticates with and drop the associated cached
+    connections, ensuring a subsequent call mints a fresh token.
+    Only valid for GitHub App (:ghconf:`app_id`) profiles.
+
+    Minted tokens are valid for one hour (fixed by GitHub) and are
+    never persisted by this extension, so revocation is optional
+    hygiene – useful e.g. as the last step of an ephemeral CI run.
+
+    .. versionadded:: 1.1.0
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt-call github.revoke_app_token
+
+    profile
+        Profile configuration name to use. Defaults to ``github``.
+    """
+    conn = _get_conn(profile)
+    gh_client.revoke_installation_token(conn)
+    # The revoked token stays attached to the connection's auth
+    # (PyGithub only re-mints on expiry, not on auth failures) -
+    # evict all context entries sharing it so later invocations
+    # build a fresh connection.
+    for key in list(__context__):
+        if key == f"github.conn.{conn.ident}" or (
+            key.startswith("github.profile.")
+            and getattr(__context__[key], "ident", None) == conn.ident
+        ):
+            __context__.pop(key)
+    return True
+
+
+def account_info(name=None, profile="github"):
+    """
+    Return the public profile of any user or organization account
+    (distinguished via the returned ``type`` field).
+
+    The scoped variants of this function — :py:func:`github_user.info
+    <saltext.github.modules.github_user.info>` and :py:func:`github_org.info
+    <saltext.github.modules.github_org.info>` — **fail** when the account
+    is not of the corresponding type.
+
+    .. versionadded:: 1.1.0
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt-call github.account_info github-handle
+        salt-call github.account_info  # the profile's owner
+
+    name
+        Login of the account to look up. Defaults to the profile's
+        :ghconf:`owner` (which itself defaults to the token's user).
+
+    profile
+        Profile configuration name to use. Defaults to ``github``.
+    """
+    return gh_users.get_info(_get_conn(profile), name)
+
+
+###########################################################################################
+# Anything below here is deprecated. Replacement functions are in github_org/github_repo. #
+###########################################################################################
+
+
+def get_user(name, profile="github", user_details=False):
+    """
+    Get a GitHub user by name.
+
+    .. deprecated:: 1.1.0
+        Despite its name, this function looks up the user's membership in
+        the profile's organization, not a generic user account. Use
+        :py:func:`github_org.get_member <saltext.github.modules.github_org.get_member>`
+        for the same functionality, or :py:func:`github.account_info
+        <saltext.github.modules.github.account_info>` for looking up arbitrary
+        accounts.
+
+    name
+        The user for which to obtain information.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    user_details
+        Prints user information details. Defaults to ``False``. If the user is
+        already in the organization and user_details is set to False, the
+        get_user function returns ``True``. If the user is not already present
+        in the organization, user details will be printed by default.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_user github-handle
+        salt myminion github.get_user github-handle user_details=true
+    """
+
+    if not user_details and name in list_users(profile):
+        # User is in the org, no need for additional Data
+        return True
+
+    try:
+        return gh_members.get_info(_get_conn(profile), name)
+    except GitHubNotFoundError:
+        log.error("Resource not found", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def list_users(profile="github", ignore_cache=False):
+    """
+    List all users within the organization.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_members <saltext.github.modules.github_org.list_members>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ignore_cache
+        Bypasses the use of cached users.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_users
+        salt myminion github.list_users profile='my-github-profile'
+    """
+    return gh_members.list_all(_get_conn(profile), ignore_cache=ignore_cache)
+
+
+def add_user(name, profile="github"):
+    """
+    Add a GitHub user.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.add_member <saltext.github.modules.github_org.add_member>` instead.
+
+    name
+        The user for which to obtain information.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.add_user github-handle
+    """
+
+    try:
+        return gh_members.invite(_get_conn(profile), name)
+    except GitHubNotFoundError:
+        log.error("Resource not found", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def remove_user(name, profile="github"):
+    """
+    Remove a Github user by name.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.remove_member <saltext.github.modules.github_org.remove_member>` instead.
+
+    name
+        The user for which to obtain information.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.remove_user github-handle
+    """
+
+    try:
+        return gh_members.remove(_get_conn(profile), name)
+    except GitHubNotFoundError:
+        log.error("Resource not found", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def get_issue(issue_number, repo_name=None, profile="github", output="min"):
+    """
+    Return information about a single issue in a named repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.get_issue <saltext.github.modules.github_repo.get_issue>` instead.
+
+    issue_number
+        The number of the issue to retrieve.
+
+    repo_name
+        The name of the repository from which to get the issue. This argument is
+        required, either passed via the CLI, or defined in the configured
+        profile. A ``repo_name`` passed as a CLI argument will override the
+        :ghconf:`repo_name` defined in the configured profile, if provided.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    output
+        The amount of data returned by each issue. Defaults to ``min``. Change
+        to ``full`` to see all issue output.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_issue 514
+        salt myminion github.get_issue 514 repo_name=salt
+    """
+    ret = {}
+    try:
+        issue_data = gh_issues.get(*_get_conn_repo(profile, repo_name), issue_number)
+    except GitHubApiError:
+        return ret
+
+    issue_id = (issue_data or {}).get("id")
+
+    if issue_id:
+        if output.lower() == "full":
+            ret[issue_id] = issue_data
+        else:
+            ret[issue_id] = gh_issues.format_issue(issue_data)
+
+    return ret
+
+
+def get_issue_comments(issue_number, repo_name=None, profile="github", since=None, output="min"):
+    """
+    Return information about the comments for a given issue in a named repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.get_issue_comments <saltext.github.modules.github_repo.get_issue_comments>` instead.
+
+    issue_number
+        The number of the issue for which to retrieve comments.
+
+    repo_name
+        The name of the repository to which the issue belongs. This argument is
+        required, either passed via the CLI, or defined in the configured
+        profile. A ``repo_name`` passed as a CLI argument will override the
+        :ghconf:`repo_name` defined in the configured profile, if provided.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    since
+        Only comments updated at or after this time are returned. This is a
+        timestamp in ISO 8601 format: ``YYYY-MM-DDTHH:MM:SSZ``.
+
+    output
+        The amount of data returned by each issue. Defaults to ``min``. Change
+        to ``full`` to see all issue output.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_issue_comments 514
+        salt myminion github.get_issue 514 repo_name=salt
+    """
+    comments = gh_issues.get_comments(
+        *_get_conn_repo(profile, repo_name), issue_number, since=since
+    )
+
+    ret = {}
+    for comment in comments or []:
+        comment_id = comment.get("id")
+        if output == "full":
+            ret[comment_id] = comment
+        else:
+            ret[comment_id] = {
+                "id": comment.get("id"),
+                "created_at": comment.get("created_at"),
+                "updated_at": comment.get("updated_at"),
+                "user_login": comment.get("user").get("login"),
+            }
+    return ret
+
+
+def get_issues(
+    repo_name=None,
+    profile="github",
+    milestone=None,
+    state="open",
+    assignee=None,
+    creator=None,
+    mentioned=None,
+    labels=None,
+    sort="created",
+    direction="desc",
+    since=None,
+    output="min",
+    per_page=None,
+):
+    """
+    Returns information for all issues in a given repository, based on the search options.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.list_issues <saltext.github.modules.github_repo.list_issues>` instead.
+
+    repo_name
+        The name of the repository for which to list issues. This argument is
+        required, either passed via the CLI, or defined in the configured
+        profile. A ``repo_name`` passed as a CLI argument will override the
+        :ghconf:`repo_name` defined in the configured profile, if provided.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    milestone
+        The number of a GitHub milestone, or a string of either ``*`` or
+        ``none``.
+
+        If a number is passed, it should refer to a milestone by its number
+        field. Use the ``github.get_milestone`` function to obtain a milestone's
+        number.
+
+        If the string ``*`` is passed, issues with any milestone are
+        accepted. If the string ``none`` is passed, issues without milestones
+        are returned.
+
+    state
+        Indicates the state of the issues to return. Can be either ``open``,
+        ``closed``, or ``all``. Default is ``open``.
+
+    assignee
+        Can be the name of a user. Pass in ``none`` (as a string) for issues
+        with no assigned user or ``*`` for issues assigned to any user.
+
+    creator
+        The user that created the issue.
+
+    mentioned
+        A user that's mentioned in the issue.
+
+    labels
+        A string of comma separated label names. For example, ``bug,ui,@high``.
+
+    sort
+        What to sort results by. Can be either ``created``, ``updated``, or
+        ``comments``. Default is ``created``.
+
+    direction
+        The direction of the sort. Can be either ``asc`` or ``desc``. Default
+        is ``desc``.
+
+    since
+        Only issues updated at or after this time are returned. This is a
+        timestamp in ISO 8601 format: ``YYYY-MM-DDTHH:MM:SSZ``.
+
+    output
+        The amount of data returned by each issue. Defaults to ``min``. Change
+        to ``full`` to see all issue output.
+
+    per_page
+        GitHub paginates data in their API calls. Use this value to increase or
+        decrease the number of issues gathered from GitHub, per page. If not set,
+        GitHub defaults are used. Maximum is 100.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_issues my-github-repo
+    """
+    issues = gh_issues.list_all(
+        *_get_conn_repo(profile, repo_name),
+        milestone=milestone,
+        state=state,
+        assignee=assignee,
+        creator=creator,
+        mentioned=mentioned,
+        labels=labels,
+        sort=sort,
+        direction=direction,
+        since=since,
+        per_page=per_page,
+    )
+
+    ret = {}
+    for issue in issues or []:
+        issue_id = issue.get("id")
+        if output == "full":
+            ret[issue_id] = issue
+        else:
+            ret[issue_id] = gh_issues.format_issue(issue)
+
+    return ret
+
+
+def get_milestones(
+    repo_name=None,
+    profile="github",
+    state="open",
+    sort="due_on",
+    direction="asc",
+    output="min",
+    per_page=None,
+):
+    """
+    Return information about milestones for a given repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.list_milestones <saltext.github.modules.github_repo.list_milestones>` instead.
+
+    repo_name
+        The name of the repository for which to list issues. This argument is
+        required, either passed via the CLI, or defined in the configured
+        profile. A ``repo_name`` passed as a CLI argument will override the
+        :ghconf:`repo_name` defined in the configured profile, if provided.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    state
+        The state of the milestone. Either ``open``, ``closed``, or ``all``.
+        Default is ``open``.
+
+    sort
+        What to sort results by. Either ``due_on`` or ``completeness``. Default
+        is ``due_on``.
+
+    direction
+        The direction of the sort. Either ``asc`` or ``desc``. Default is ``asc``.
+
+    output
+        The amount of data returned by each issue. Defaults to ``min``. Change
+        to ``full`` to see all issue output.
+
+    per_page
+        GitHub paginates data in their API calls. Use this value to increase or
+        decrease the number of issues gathered from GitHub, per page. If not set,
+        GitHub defaults are used.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_milestones
+    """
+    milestones = gh_milestones.list_all(
+        *_get_conn_repo(profile, repo_name),
+        state=state,
+        sort=sort,
+        direction=direction,
+        per_page=per_page,
+    )
+
+    ret = {}
+    for milestone in milestones or []:
+        milestone_id = milestone.get("id")
+        if output == "full":
+            ret[milestone_id] = milestone
+        else:
+            ret[milestone_id] = gh_milestones.format_milestone(milestone)
+
+    return ret
+
+
+def get_milestone(number=None, name=None, repo_name=None, profile="github", output="min"):
+    """
+    Return information about a single milestone in a named repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.get_milestone <saltext.github.modules.github_repo.get_milestone>` instead.
+
+    number
+        The number of the milestone to retrieve. If provided, this option
+        will be favored over ``name``.
+
+    name
+        The name of the milestone to retrieve.
+
+    repo_name
+        The name of the repository for which to list issues. This argument is
+        required, either passed via the CLI, or defined in the configured
+        profile. A ``repo_name`` passed as a CLI argument will override the
+        :ghconf:`repo_name` defined in the configured profile, if provided.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    output
+        The amount of data returned by each issue. Defaults to ``min``. Change
+        to ``full`` to see all issue output.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_milestone 72
+        salt myminion github.get_milestone name=my_milestone
+    """
+    if not (number or name):
+        raise CommandExecutionError("Either a milestone 'name' or 'number' must be provided.")
+
+    ret = {}
+
+    if number:
+        try:
+            milestone_data = gh_milestones.get(*_get_conn_repo(profile, repo_name), number)
+        except GitHubApiError:
+            return ret
+        milestone_id = (milestone_data or {}).get("id")
+        if milestone_id:
+            if output.lower() == "full":
+                ret[milestone_id] = milestone_data
+            else:
+                ret[milestone_id] = gh_milestones.format_milestone(milestone_data)
+        return ret
+
+    milestones = get_milestones(repo_name=repo_name, profile=profile, output=output)
+    for key, val in milestones.items():
+        if val.get("title") == name:
+            ret[key] = val
+            return ret
+
+    return ret
+
+
+def get_repo_info(repo_name, profile="github", ignore_cache=False):
+    """
+    Return information for a given repo.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.info <saltext.github.modules.github_repo.info>` instead.
+
+    repo_name
+        The name of the repository.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_repo_info salt
+        salt myminion github.get_repo_info salt profile='my-github-profile'
+    """
+    info = gh_repos.get_info(_get_conn(profile), repo_name, ignore_cache=ignore_cache)
+    # The legacy output contained GitHub's deprecated alias fields
+    return {
+        **info,
+        "watchers_count": info["stargazers_count"],
+        "watchers": info["stargazers_count"],
+        "forks": info["forks_count"],
+        "open_issues": info["open_issues_count"],
+    }
+
+
+def get_repo_teams(repo_name, profile="github"):
+    """
+    Return teams belonging to a repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.get_teams <saltext.github.modules.github_repo.get_teams>` instead.
+
+    repo_name
+        The name of the repository from which to retrieve teams.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_repo_teams salt
+        salt myminion github.get_repo_teams salt profile='my-github-profile'
+    """
+    return gh_repos.get_teams(_get_conn(profile), repo_name)
+
+
+def list_repos(profile="github"):
+    """
+    List all repositories within the organization. Includes public and private
+    repositories within the organization Dependent upon the access rights of
+    the profile token.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_repos <saltext.github.modules.github_org.list_repos>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_repos
+        salt myminion github.list_repos profile='my-github-profile'
+    """
+    return [repo.name for repo in gh_repos.list_all(_get_conn(profile))]
+
+
+def list_private_repos(profile="github"):
+    """
+    List private repositories within the organization. Dependent upon the access
+    rights of the profile token.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_repos <saltext.github.modules.github_org.list_repos>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_private_repos
+        salt myminion github.list_private_repos profile='my-github-profile'
+    """
+    return [repo.name for repo in gh_repos.list_all(_get_conn(profile)) if repo.private is True]
+
+
+def list_public_repos(profile="github"):
+    """
+    List public repositories within the organization.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_repos <saltext.github.modules.github_org.list_repos>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_public_repos
+        salt myminion github.list_public_repos profile='my-github-profile'
+    """
+    return [repo.name for repo in gh_repos.list_all(_get_conn(profile)) if repo.private is False]
+
+
+def add_repo(
+    name,
+    description=None,
+    homepage=None,
+    private=None,
+    has_issues=None,
+    has_wiki=None,
+    has_downloads=None,
+    auto_init=None,
+    gitignore_template=None,
+    license_template=None,
+    profile="github",
+):
+    """
+    Create a new github repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.add_repo <saltext.github.modules.github_org.add_repo>` instead.
+
+    name
+        The name of the team to be created.
+
+    description
+        The description of the repository.
+
+    homepage
+        The URL with more information about the repository.
+
+    private
+        The visiblity of the repository. Note that private repositories require
+        a paid GitHub account.
+
+    has_issues
+        Whether to enable issues for this repository.
+
+    has_wiki
+        Whether to enable the wiki for this repository.
+
+    has_downloads
+        Whether to enable downloads for this repository.
+
+    auto_init
+        Whether to create an initial commit with an empty README.
+
+    gitignore_template
+        The desired language or platform for a .gitignore, e.g "Haskell".
+
+    license_template
+        The desired LICENSE template to apply, e.g "mit" or "mozilla".
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.add_repo 'repo_name'
+    """
+    try:
+        gh_repos.create(
+            _get_conn(profile),
+            name,
+            description=description,
+            homepage=homepage,
+            private=private,
+            has_issues=has_issues,
+            has_wiki=has_wiki,
+            has_downloads=has_downloads,
+            auto_init=auto_init,
+            gitignore_template=gitignore_template,
+            license_template=license_template,
+        )
+        return True
+    except GitHubApiError:
+        log.error("Error creating a repo", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def edit_repo(
+    name,
+    description=None,
+    homepage=None,
+    private=None,
+    has_issues=None,
+    has_wiki=None,
+    has_downloads=None,
+    profile="github",
+):
+    """
+    Updates an existing Github repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.update <saltext.github.modules.github_repo.update>` instead.
+
+    name
+        The name of the team to be created.
+
+    description
+        The description of the repository.
+
+    homepage
+        The URL with more information about the repository.
+
+    private
+        The visiblity of the repository. Note that private repositories require
+        a paid GitHub account.
+
+    has_issues
+        Whether to enable issues for this repository.
+
+    has_wiki
+        Whether to enable the wiki for this repository.
+
+    has_downloads
+        Whether to enable downloads for this repository.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.add_repo 'repo_name'
+    """
+
+    try:
+        allow_privacy_change = _get_config_value(profile, "allow_repo_privacy_changes")
+    except CommandExecutionError:
+        allow_privacy_change = False
+
+    try:
+        gh_repos.update(
+            _get_conn(profile),
+            name,
+            description=description,
+            homepage=homepage,
+            private=private,
+            has_issues=has_issues,
+            has_wiki=has_wiki,
+            has_downloads=has_downloads,
+            allow_privacy_change=allow_privacy_change,
+        )
+        return True
+    except GitHubApiError:
+        log.error("Error editing a repo", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def remove_repo(name, profile="github"):
+    """
+    Remove a Github repository.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.delete <saltext.github.modules.github_repo.delete>` instead.
+
+    name
+        The name of the repository to be removed.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.remove_repo 'my-repo'
+    """
+    conn = _get_conn(profile)
+    try:
+        gh_repos.get_info(conn, name)
+    except CommandExecutionError:
+        log.error("Repo %s to be removed does not exist.", name)
+        return False
+    try:
+        gh_repos.delete(conn, name)
+        return True
+    except GitHubApiError:
+        log.error("Error deleting a repo", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def get_team(name, profile="github"):
+    """
+    Returns the team details if a team with the given name exists, or None
+    otherwise.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.get_team <saltext.github.modules.github_org.get_team>` instead.
+
+    name
+        The team name for which to obtain information.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_team 'team_name'
+    """
+    return gh_teams.get(_get_conn(profile), name)
+
+
+def add_team(
+    name,
+    description=None,
+    repo_names=None,
+    privacy=None,
+    permission=None,
+    profile="github",
+):
+    """
+    Create a new Github team within an organization.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.add_team <saltext.github.modules.github_org.add_team>` instead.
+
+    name
+        The name of the team to be created.
+
+    description
+        The description of the team.
+
+    repo_names
+        The names of repositories to add the team to.
+
+    privacy
+        The level of privacy for the team, can be ``secret`` or ``closed``.
+
+    permission
+        The default permission for new repositories added to the team, can be
+        ``pull``, ``push`` or ``admin``.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.add_team 'team_name'
+    """
+    try:
+        gh_teams.create(
+            _get_conn(profile),
+            name,
+            description=description,
+            repo_names=repo_names,
+            privacy=privacy,
+            permission=permission,
+        )
+        return True
+    except GitHubApiError:
+        log.error("Error creating a team", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def edit_team(name, description=None, privacy=None, permission=None, profile="github"):
+    """
+    Updates an existing Github team.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.edit_team <saltext.github.modules.github_org.edit_team>` instead.
+
+    name
+        The name of the team to be edited.
+
+    description
+        The description of the team.
+
+    privacy
+        The level of privacy for the team, can be ``secret`` or ``closed``.
+
+    permission
+        The default permission for new repositories added to the team, can be
+        ``pull``, ``push`` or ``admin``.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.edit_team 'team_name' description='Team description'
+    """
+    conn = _get_conn(profile)
+    team = gh_teams.get(conn, name)
+    if not team:
+        log.error("Team %s does not exist", name)
+        return False
+    try:
+        gh_teams.update(
+            conn,
+            team,
+            name,
+            description=description,
+            privacy=privacy,
+            permission=permission,
+        )
+        return True
+    except GitHubNotFoundError:
+        log.error("Resource not found", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def remove_team(name, profile="github"):
+    """
+    Remove a github team.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.remove_team <saltext.github.modules.github_org.remove_team>` instead.
+
+    name
+        The name of the team to be removed.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.remove_team 'team_name'
+    """
+    conn = _get_conn(profile)
+    team_info = gh_teams.get(conn, name)
+    if not team_info:
+        log.error("Team %s to be removed does not exist.", name)
+        return False
+    try:
+        gh_teams.delete(conn, team_info)
+        return gh_teams.get(conn, name) is None
+    except GitHubApiError:
+        log.error("Error deleting a team", exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def list_team_repos(team_name, profile="github", ignore_cache=False):
+    """
+    Gets the repo details for a given team as a dict from repo_name to repo details.
+    Note that repo names are always in lower case.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_team_repos <saltext.github.modules.github_org.list_team_repos>` instead.
+
+    team_name
+        The name of the team from which to list repos.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ignore_cache
+        Bypasses the use of cached team repos.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_team_repos 'team_name'
+    """
+    conn = _get_conn(profile)
+    cached_team = gh_teams.get(conn, team_name)
+    if not cached_team:
+        log.error("Team %s does not exist.", team_name)
+        return False
+
+    try:
+        return gh_teams.list_repos(conn, cached_team, ignore_cache=ignore_cache)
+    except GitHubNotFoundError:
+        log.error("Resource not found: %s", cached_team["id"], exc_info_on_loglevel=logging.DEBUG)
+        return {}
+
+
+def add_team_repo(repo_name, team_name, profile="github", permission=None):
+    """
+    Adds a repository to a team with team_name.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.add_team_repo <saltext.github.modules.github_org.add_team_repo>` instead.
+
+    repo_name
+        The name of the repository to add.
+
+    team_name
+        The name of the team of which to add the repository.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    permission
+        The permission for team members within the repository, can be ``pull``,
+        ``push`` or ``admin``. If not specified, the default permission specified on
+        the team will be used.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.add_team_repo 'my_repo' 'team_name'
+    """
+    conn = _get_conn(profile)
+    team_info = gh_teams.get(conn, team_name)
+    if not team_info:
+        log.error("Team %s does not exist", team_name)
+        return False
+    try:
+        gh_teams.add_repo(conn, team_info, repo_name, permission=permission)
+    except GitHubNotFoundError:
+        log.error("Resource not found: %s", team_info["id"], exc_info_on_loglevel=logging.DEBUG)
+        return False
+    except CommandExecutionError as err:
+        log.error(str(err), exc_info_on_loglevel=logging.DEBUG)
+        return False
+    return True
+
+
+def remove_team_repo(repo_name, team_name, profile="github"):
+    """
+    Removes a repository from a team with team_name.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.remove_team_repo <saltext.github.modules.github_org.remove_team_repo>` instead.
+
+    repo_name
+        The name of the repository to remove.
+
+    team_name
+        The name of the team of which to remove the repository.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.remove_team_repo 'my_repo' 'team_name'
+    """
+    conn = _get_conn(profile)
+    team_info = gh_teams.get(conn, team_name)
+    if not team_info:
+        log.error("Team %s does not exist", team_name)
+        return False
+    try:
+        return gh_teams.remove_repo(conn, team_info, repo_name)
+    except GitHubNotFoundError:
+        log.error("Resource not found: %s", team_info["id"], exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def list_team_members(team_name, profile="github", ignore_cache=False):
+    """
+    Gets the names of team members in lower case.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_team_members <saltext.github.modules.github_org.list_team_members>` instead.
+
+    team_name
+        The name of the team from which to list members.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ignore_cache
+        Bypasses the use of cached team members.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_team_members 'team_name'
+    """
+    conn = _get_conn(profile)
+    cached_team = gh_teams.get(conn, team_name)
+    if not cached_team:
+        log.error("Team %s does not exist.", team_name)
+        return False
+
+    try:
+        return gh_teams.list_members(conn, cached_team, ignore_cache=ignore_cache)
+    except GitHubNotFoundError:
+        log.error("Resource not found: %s", cached_team["id"], exc_info_on_loglevel=logging.DEBUG)
+        return []
+
+
+def list_members_without_mfa(profile="github", ignore_cache=False):
+    """
+    List all members (in lower case) without MFA turned on.
+
+    .. deprecated:: 1.1.0
+        Deprecated without replacement, along with the per-team MFA
+        enforcement of the ``github.team_present`` state. Require 2FA
+        organization-wide in the GitHub settings instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ignore_cache
+        Bypasses the use of cached team repos.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_members_without_mfa
+    """
+    return gh_members.list_without_mfa(_get_conn(profile), ignore_cache=ignore_cache)
+
+
+def is_team_member(name, team_name, profile="github"):
+    """
+    Returns True if the github user is in the team with team_name, or False
+    otherwise.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.is_team_member <saltext.github.modules.github_org.is_team_member>` instead.
+
+    name
+        The name of the user whose membership to check.
+
+    team_name
+        The name of the team to check membership in.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.is_team_member 'user_name' 'team_name'
+    """
+    # list_team_members returns False for missing teams
+    return name.lower() in (list_team_members(team_name, profile=profile) or [])
+
+
+def add_team_member(name, team_name, profile="github"):
+    """
+    Adds a team member to a team with team_name.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.add_team_member <saltext.github.modules.github_org.add_team_member>` instead.
+
+    name
+        The name of the team member to add.
+
+    team_name
+        The name of the team of which to add the user.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.add_team_member 'user_name' 'team_name'
+    """
+    conn = _get_conn(profile)
+    team_info = gh_teams.get(conn, team_name)
+    if not team_info:
+        log.error("Team %s does not exist", team_name)
+        return False
+    try:
+        gh_teams.add_member(conn, team_info, name)
+    except GitHubNotFoundError:
+        log.error("Resource not found: %s", team_info["id"], exc_info_on_loglevel=logging.DEBUG)
+        return False
+    except GitHubApiError:
+        log.error("Error in adding a member to a team", exc_info_on_loglevel=logging.DEBUG)
+        return False
+    return True
+
+
+def remove_team_member(name, team_name, profile="github"):
+    """
+    Removes a team member from a team with team_name.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.remove_team_member <saltext.github.modules.github_org.remove_team_member>` instead.
+
+    name
+        The name of the team member to remove.
+
+    team_name
+        The name of the team from which to remove the user.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.remove_team_member 'user_name' 'team_name'
+    """
+    conn = _get_conn(profile)
+    team_info = gh_teams.get(conn, team_name)
+    if not team_info:
+        log.error("Team %s does not exist", team_name)
+        return False
+    try:
+        return gh_teams.remove_member(conn, team_info, name)
+    except GitHubNotFoundError:
+        log.error("Resource not found: %s", team_info["id"], exc_info_on_loglevel=logging.DEBUG)
+        return False
+
+
+def list_teams(profile="github", ignore_cache=False):
+    """
+    Lists all teams with the organization.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_teams <saltext.github.modules.github_org.list_teams>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ignore_cache
+        Bypasses the use of cached teams.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_teams
+    """
+    return gh_teams.list_all(_get_conn(profile), ignore_cache=ignore_cache)
+
+
+def get_prs(
+    repo_name=None,
+    profile="github",
+    state="open",
+    head=None,
+    base=None,
+    sort="created",
+    direction="desc",
+    output="min",
+    per_page=None,
+):
+    """
+    Returns information for all pull requests in a given repository, based on
+    the search options provided.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_repo.list_pulls <saltext.github.modules.github_repo.list_pulls>` instead.
+
+    repo_name
+        The name of the repository for which to list pull requests. This
+        argument is required, either passed via the CLI, or defined in the
+        configured profile. A ``repo_name`` passed as a CLI argument will
+        override the ``repo_name`` defined in the configured profile, if
+        provided.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    state
+        Indicates the state of the pull requests to return. Can be either
+        ``open``, ``closed``, or ``all``. Default is ``open``.
+
+    head
+        Filter pull requests by head user and branch name in the format of
+        ``user:ref-name``. Example: ``'github:new-script-format'``. Default
+        is ``None``.
+
+    base
+        Filter pulls by base branch name. Example: ``gh-pages``. Default is
+        ``None``.
+
+    sort
+        What to sort results by. Can be either ``created``, ``updated``,
+        ``popularity`` (comment count), or ``long-running`` (age, filtering
+        by pull requests updated within the last month). Default is ``created``.
+
+    direction
+        The direction of the sort. Can be either ``asc`` or ``desc``. Default
+        is ``desc``.
+
+    output
+        The amount of data returned by each pull request. Defaults to ``min``.
+        Change to ``full`` to see all pull request output.
+
+    per_page
+        GitHub paginates data in their API calls. Use this value to increase or
+        decrease the number of pull requests gathered from GitHub, per page. If
+        not set, GitHub defaults are used. Maximum is 100.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_prs
+        salt myminion github.get_prs base=2016.11
+    """
+    prs = gh_pulls.list_all(
+        *_get_conn_repo(profile, repo_name),
+        state=state,
+        head=head,
+        base=base,
+        sort=sort,
+        direction=direction,
+        per_page=per_page,
+    )
+
+    ret = {}
+    for pr_ in prs or []:
+        pr_id = pr_.get("id")
+        if output == "full":
+            ret[pr_id] = pr_
+        else:
+            ret[pr_id] = gh_pulls.format_pr(pr_)
+
+    return ret
+
+
+def _resolve_ruleset_params(
+    profile,
+    require_id=False,
+    require_params=False,
+    *,
+    ruleset_type=None,
+    owner=None,
+    repo_name=None,
+    org_name=None,
+    header_dict=None,
+    ruleset_id=None,
+    ruleset_params=None,
+    **_,
+):
+    """
+    Helper function that merges CLI parameters with profile configuration
+    defaults for ruleset operations.
+
+    profile
+        The name of the profile configuration to use.
+
+    require_id
+        Require ruleset_id. Defaults to false.
+
+    require_params
+        Require ruleset_params payload. Defaults to false.
+    """
+    ruleset_type = ruleset_type or _get_config_value(profile, "ruleset_type")
+    if ruleset_type not in ("repo", "org"):
+        raise CommandExecutionError(f"Invalid ruleset type: {ruleset_type}")
+
+    # Unset owners fall back to the connection default (the profile's
+    # owner or the token's user) in the ruleset utils.
+    if ruleset_type == "repo":
+        owner = owner or _get_owner(profile)
+        repo_name = repo_name or _get_config_value(profile, "repo_name")
+    else:
+        org_name = org_name or _get_owner(profile)
+
+    # check for optional header_dict
+    try:
+        header_dict = header_dict or _get_config_value(profile, "header_dict")
+    except CommandExecutionError:
+        header_dict = {}
+
+    # verify header_dict is a dict
+    if not isinstance(header_dict, dict):
+        header_dict = {}
+
+    # if ruleset is required, check for ruleset_id
+    if require_id:
+        ruleset_id = ruleset_id or _get_config_value(profile, "ruleset_id")
+
+    # if ruleset_params are required, check for ruleset_params
+    if require_params:
+        ruleset_params = ruleset_params or _get_config_value(profile, "ruleset_params")
+
+    return filter_unset(
+        {
+            "ruleset_type": ruleset_type,
+            "owner": owner,
+            "repo_name": repo_name,
+            "org_name": org_name,
+            "headers": header_dict,
+            "ruleset_id": ruleset_id,
+            "ruleset_params": ruleset_params,
+        }
+    )
+
+
+def _ruleset_error_ret(err):
+    """
+    Format a :class:`GitHubApiError` into the legacy ruleset return shape.
+    """
+    ret = {"status": err.status, "error": str(err)}
+    if err.data is not None:
+        ret["dict"] = err.data
+    ret["comment"] = f"GitHub Response Status Code: {err}"
+    ret["result"] = False
+    return ret
+
+
+def get_ruleset(profile="github", **kwargs):
+    """
+    Get information of specific ruleset.
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.get_ruleset <saltext.github.modules.github_org.get_ruleset>` or
+        :py:func:`github_repo.get_ruleset <saltext.github.modules.github_repo.get_ruleset>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ruleset_type
+        The type of ruleset. ``repo`` or ``org``.
+
+    ruleset_id
+        Id of the ruleset.
+
+    owner
+        The account owner of the repository.
+
+    repo_name
+        The name of the repo.
+
+    org_name
+        The name of the organization.
+
+    header_dict
+        Headers to pass to Github API.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.get_ruleset
+        salt myminion github.get_ruleset ruleset_id=1
+    """
+    params = _resolve_ruleset_params(profile, require_id=True, **kwargs)
+    params.pop("ruleset_params", None)
+    try:
+        return gh_rulesets.get(
+            _get_conn(profile), params.pop("ruleset_id"), params.pop("ruleset_type"), **params
+        )
+    except GitHubApiError as err:
+        return _ruleset_error_ret(err)
+    except CommandExecutionError:
+        return {"result": False, "comment": "Error getting ruleset"}
+
+
+def delete_ruleset(profile="github", **kwargs):
+    """
+    Delete ruleset
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.delete_ruleset <saltext.github.modules.github_org.delete_ruleset>` or
+        :py:func:`github_repo.delete_ruleset <saltext.github.modules.github_repo.delete_ruleset>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ruleset_type
+        The type of ruleset. ``repo`` or ``org``.
+
+    owner
+        The account owner of the repository.
+
+    repo_name
+        The name of the repo.
+
+    ruleset_id
+        Id of the ruleset.
+
+    org_name
+        The name of the organization.
+
+    header_dict
+        Headers to pass to Github API.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.delete_ruleset
+        salt myminion github.delete_ruleset ruleset_id=1
+    """
+    params = _resolve_ruleset_params(profile, require_id=True, **kwargs)
+    params.pop("ruleset_params", None)
+    ruleset_id = params.pop("ruleset_id")
+    try:
+        gh_rulesets.delete(_get_conn(profile), ruleset_id, params.pop("ruleset_type"), **params)
+        return {"comment": f"ruleset {ruleset_id} successfully deleted"}
+    except GitHubApiError as err:
+        return _ruleset_error_ret(err)
+    except CommandExecutionError:
+        return {"result": False, "comment": "Error deleting ruleset"}
+
+
+def update_ruleset(profile="github", **kwargs):
+    """
+    Update ruleset
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.update_ruleset <saltext.github.modules.github_org.update_ruleset>` or
+        :py:func:`github_repo.update_ruleset <saltext.github.modules.github_repo.update_ruleset>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ruleset_type
+        The type of ruleset. ``repo`` or ``org``.
+
+    ruleset_id
+        Id of the ruleset.
+
+    owner
+        The account owner of the repository.
+
+    repo_name
+        The name of the repo.
+
+    org_name
+        The name of the organization.
+
+    header_dict
+        headers to pass to Github API.
+
+    ruleset_params
+        The updated ruleset definition.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.update_ruleset
+        salt myminion github.update_ruleset ruleset_id=1
+    """
+    params = _resolve_ruleset_params(profile, require_id=True, require_params=True, **kwargs)
+    ruleset_id = params.pop("ruleset_id")
+    ruleset_params = params.pop("ruleset_params")
+    gh_rulesets.check_params(ruleset_params)
+    try:
+        return gh_rulesets.update(
+            _get_conn(profile),
+            ruleset_id,
+            ruleset_params,
+            params.pop("ruleset_type"),
+            **params,
+        )
+    except GitHubApiError as err:
+        return _ruleset_error_ret(err)
+    except CommandExecutionError:
+        return {"result": False, "comment": "Error updating ruleset"}
+
+
+def add_ruleset(profile="github", **kwargs):
+    """
+    Add ruleset
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.add_ruleset <saltext.github.modules.github_org.add_ruleset>` or
+        :py:func:`github_repo.add_ruleset <saltext.github.modules.github_repo.add_ruleset>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ruleset_type
+        The type of ruleset. ``repo`` or ``org``.
+
+    owner
+        The account owner of the repository.
+
+    repo_name
+        The name of the repo.
+
+    org_name
+        The name of the organization.
+
+    header_dict
+        headers to pass to Github API.
+
+    ruleset_params
+        The ruleset definition. Must contain at least ``name`` and
+        ``enforcement``.
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.add_ruleset
+    """
+    params = _resolve_ruleset_params(profile, require_params=True, **kwargs)
+    params.pop("ruleset_id", None)
+    ruleset_params = params.pop("ruleset_params")
+    gh_rulesets.check_params(ruleset_params, required={"name", "enforcement"})
+    try:
+        return gh_rulesets.create(
+            _get_conn(profile), ruleset_params, params.pop("ruleset_type"), **params
+        )
+    except GitHubApiError as err:
+        return _ruleset_error_ret(err)
+    except CommandExecutionError:
+        return {"result": False, "comment": "Error adding ruleset"}
+
+
+def list_rulesets(profile="github", *, per_page=None, **kwargs):
+    """
+    List rulesets
+
+    .. deprecated:: 1.1.0
+        Use :py:func:`github_org.list_rulesets <saltext.github.modules.github_org.list_rulesets>` or
+        :py:func:`github_repo.list_rulesets <saltext.github.modules.github_repo.list_rulesets>` instead.
+
+    profile
+        The name of the profile configuration to use. Defaults to ``github``.
+
+    ruleset_type
+        The type of ruleset. ``repo`` or ``org``.
+
+    owner
+        The account owner of the repository.
+
+    repo_name
+        The name of the repo.
+
+    org_name
+        The name of the organization.
+
+    header_dict
+        headers to pass to Github API.
+
+    per_page
+        number of returned results (max 100).
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt myminion github.list_rulesets
+    """
+    params = _resolve_ruleset_params(profile, **kwargs)
+    params.pop("ruleset_id", None)
+    params.pop("ruleset_params", None)
+    try:
+        per_page = per_page if per_page is not None else _get_config_value(profile, "per_page")
+    except CommandExecutionError:
+        per_page = None
+
+    try:
+        rulesets = gh_rulesets.list_all(
+            _get_conn(profile), params.pop("ruleset_type"), per_page=per_page, **params
+        )
+        return {"rulesets": rulesets or None}
+    except GitHubApiError as err:
+        return _ruleset_error_ret(err)
+    except CommandExecutionError:
+        return {"result": False, "comment": "Error getting rulesets"}