Skip to content

GitHub

GitHub resources (repositories, branch protection, team membership, deploy keys, collaborators) for Sanoma, read through the OpenTofu provider, and repositories generated, committed to and given deploy keys through Sanoma's GitHub App; and Copilot, a coding agent for the chat on a person's own plan.

Package @sanoma-ai/connector-github, version 0.11.24. Its README, with how to install and connect it, is on GitHub.

Resource types, which a data file under resources/ declares: github.repository, github.branch_protection, github.team_membership, github.repository_deploy_key, github.repository_collaborator.

installation

get

github.installation.getreadsafe to retry

Read an installation of the GitHub App: the account it is on and which repositories it covers

Input

  • idintegerrequired

    The installation's id

    more than 0

Output

  • idnumberrequired
  • accountobjectrequired
    Fields
    • loginstringrequired
    • idnumberrequired
    • type"User" | "Organization"required
  • repositorySelection"all" | "selected"required

repository

import

github.repository.importreadsafe to retry

Find a repository by its owner/name or its binding id and read it; gone when there is none

Input

  • idstringrequired

    at least 1 character

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • allow_auto_mergeboolean | null

      Set to 'true' to allow auto-merging pull requests on the repository.

    • allow_forkingboolean | null

      Set to 'true' to allow private forking on the repository; this is only relevant if the repository is owned by an organization and is private or internal.

    • allow_merge_commitboolean | null

      Set to 'false' to disable merge commits on the repository.

    • allow_rebase_mergeboolean | null

      Set to 'false' to disable rebase merges on the repository.

    • allow_squash_mergeboolean | null

      Set to 'false' to disable squash merges on the repository.

    • allow_update_branchboolean | null

      Set to 'true' to always suggest updating pull request branches.

    • archive_on_destroyboolean | null

      Set to 'true' to archive the repository instead of deleting on destroy.

    • archivedboolean | null

      Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving.

    • auto_initboolean | null

      Set to 'true' to produce an initial commit in the repository.

    • default_branchstring | nulldeprecated

      Can only be set after initial repository creation, and only if the target branch exists

    • delete_branch_on_mergeboolean | null

      Automatically delete head branch after a pull request is merged. Defaults to 'false'.

    • descriptionstring | null

      A description of the repository.

    • etagstring | null
    • forkstring | null

      Set to 'true' to fork an existing repository.

    • full_namestring | null

      A string of the form 'orgname/reponame'.

    • git_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository anonymously via the git protocol.

    • gitignore_templatestring | null

      Use the name of the template without the extension. For example, 'Haskell'.

    • has_discussionsboolean | null

      Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'.

    • has_downloadsboolean | nulldeprecated

      Set to 'true' to enable the (deprecated) downloads features on the repository.

    • has_issuesboolean | null

      Set to 'true' to enable the GitHub Issues features on the repository

    • has_projectsboolean | null

      Set to 'true' to enable the GitHub Projects features on the repository. Per the GitHub documentation when in an organization that has disabled repository projects it will default to 'false' and will otherwise default to 'true'. If you specify 'true' when it has been disabled it will return an error.

    • has_wikiboolean | null

      Set to 'true' to enable the GitHub Wiki features on the repository.

    • homepage_urlstring | null

      URL of a page describing the project.

    • html_urlstring | null

      URL to the repository on the web.

    • http_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via HTTPS.

    • idstring | null
    • ignore_vulnerability_alerts_during_readboolean | nulldeprecated
    • is_templateboolean | null

      Set to 'true' to tell GitHub that this is a template repository.

    • license_templatestring | null

      Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'.

    • merge_commit_messagestring | null

      Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message.

    • merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title.

    • namestringrequired

      The name of the repository.

    • node_idstring | null

      GraphQL global node id for use with v4 API.

    • primary_languagestring | null
    • privateboolean | nulldeprecated
    • repo_idnumber | null

      GitHub ID for the repository.

    • source_ownerstring | null

      The owner of the source repository to fork from.

    • source_repostring | null

      The name of the source repository to fork from.

    • squash_merge_commit_messagestring | null

      Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message.

    • squash_merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title.

    • ssh_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via SSH.

    • svn_urlstring | null

      URL that can be provided to 'svn checkout' to check out the repository via GitHub's Subversion protocol emulation.

    • topicsstring[] | null

      The list of topics of the repository.

    • visibilitystring | null

      Can be 'public' or 'private'. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be 'internal'.

    • vulnerability_alertsboolean | nulldeprecated

      Set to 'true' to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on all repos by default). Note that vulnerability alerts have not been successfully tested on any GitHub Enterprise instance and may be unavailable in those settings.

    • web_commit_signoff_requiredboolean | null

      Require contributors to sign off on web-based commits.

    • pagesobject | null

      The repository's GitHub Pages configuration

      Fields
      • build_typestring | null

        The type the page should be sourced.

      • cnamestring | null

        The custom domain for the repository. This can only be set after the repository has been created.

      • custom_404boolean | null

        Whether the rendered GitHub Pages site has a custom 404 page

      • html_urlstring | null

        URL to the repository on the web.

      • statusstring | null

        The GitHub Pages site's build status e.g. building or built.

      • urlstring | null
      • sourceobject | null

        The source branch and directory for the rendered Pages site.

        Fields
        • branchstringrequired

          The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages')

        • pathstring | null

          The repository directory from which the site publishes (Default: '/')

    • security_and_analysisobject | null

      Security and analysis settings for the repository. To use this parameter you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository.

      Fields
      • advanced_securityobject | null

        The advanced security configuration for the repository. If a repository's visibility is 'public', advanced security is always enabled and cannot be changed, so this setting cannot be supplied.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable advanced security features on the repository. Can be 'enabled' or 'disabled', This value being present when split licensing is enabled will error out.

      • code_securityobject | null

        The code security configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable code security on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanningobject | null

        The secret scanning configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_ai_detectionobject | null

        The secret scanning AI detection configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning AI detection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_non_provider_patternsobject | null

        The secret scanning non-provider patterns configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning non-provider patterns on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_push_protectionobject | null

        The secret scanning push protection configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning push protection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

    • templateobject | null

      Use a template repository to create this resource.

      Fields
      • include_all_branchesboolean | null

        Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template).

      • ownerstringrequired

        The GitHub organization or user the template repository is owned by.

      • repositorystringrequired

        The name of the template repository.

    • ownerstringrequired

      The organization or user the repository belongs to

      at least 1 character

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

read

github.repository.readreadsafe to retry

Read a repository as it is now; gone when it no longer exists

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • allow_auto_mergeboolean | null

      Set to 'true' to allow auto-merging pull requests on the repository.

    • allow_forkingboolean | null

      Set to 'true' to allow private forking on the repository; this is only relevant if the repository is owned by an organization and is private or internal.

    • allow_merge_commitboolean | null

      Set to 'false' to disable merge commits on the repository.

    • allow_rebase_mergeboolean | null

      Set to 'false' to disable rebase merges on the repository.

    • allow_squash_mergeboolean | null

      Set to 'false' to disable squash merges on the repository.

    • allow_update_branchboolean | null

      Set to 'true' to always suggest updating pull request branches.

    • archive_on_destroyboolean | null

      Set to 'true' to archive the repository instead of deleting on destroy.

    • archivedboolean | null

      Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving.

    • auto_initboolean | null

      Set to 'true' to produce an initial commit in the repository.

    • default_branchstring | nulldeprecated

      Can only be set after initial repository creation, and only if the target branch exists

    • delete_branch_on_mergeboolean | null

      Automatically delete head branch after a pull request is merged. Defaults to 'false'.

    • descriptionstring | null

      A description of the repository.

    • etagstring | null
    • forkstring | null

      Set to 'true' to fork an existing repository.

    • full_namestring | null

      A string of the form 'orgname/reponame'.

    • git_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository anonymously via the git protocol.

    • gitignore_templatestring | null

      Use the name of the template without the extension. For example, 'Haskell'.

    • has_discussionsboolean | null

      Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'.

    • has_downloadsboolean | nulldeprecated

      Set to 'true' to enable the (deprecated) downloads features on the repository.

    • has_issuesboolean | null

      Set to 'true' to enable the GitHub Issues features on the repository

    • has_projectsboolean | null

      Set to 'true' to enable the GitHub Projects features on the repository. Per the GitHub documentation when in an organization that has disabled repository projects it will default to 'false' and will otherwise default to 'true'. If you specify 'true' when it has been disabled it will return an error.

    • has_wikiboolean | null

      Set to 'true' to enable the GitHub Wiki features on the repository.

    • homepage_urlstring | null

      URL of a page describing the project.

    • html_urlstring | null

      URL to the repository on the web.

    • http_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via HTTPS.

    • idstring | null
    • ignore_vulnerability_alerts_during_readboolean | nulldeprecated
    • is_templateboolean | null

      Set to 'true' to tell GitHub that this is a template repository.

    • license_templatestring | null

      Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'.

    • merge_commit_messagestring | null

      Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message.

    • merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title.

    • namestringrequired

      The name of the repository.

    • node_idstring | null

      GraphQL global node id for use with v4 API.

    • primary_languagestring | null
    • privateboolean | nulldeprecated
    • repo_idnumber | null

      GitHub ID for the repository.

    • source_ownerstring | null

      The owner of the source repository to fork from.

    • source_repostring | null

      The name of the source repository to fork from.

    • squash_merge_commit_messagestring | null

      Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message.

    • squash_merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title.

    • ssh_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via SSH.

    • svn_urlstring | null

      URL that can be provided to 'svn checkout' to check out the repository via GitHub's Subversion protocol emulation.

    • topicsstring[] | null

      The list of topics of the repository.

    • visibilitystring | null

      Can be 'public' or 'private'. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be 'internal'.

    • vulnerability_alertsboolean | nulldeprecated

      Set to 'true' to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on all repos by default). Note that vulnerability alerts have not been successfully tested on any GitHub Enterprise instance and may be unavailable in those settings.

    • web_commit_signoff_requiredboolean | null

      Require contributors to sign off on web-based commits.

    • pagesobject | null

      The repository's GitHub Pages configuration

      Fields
      • build_typestring | null

        The type the page should be sourced.

      • cnamestring | null

        The custom domain for the repository. This can only be set after the repository has been created.

      • custom_404boolean | null

        Whether the rendered GitHub Pages site has a custom 404 page

      • html_urlstring | null

        URL to the repository on the web.

      • statusstring | null

        The GitHub Pages site's build status e.g. building or built.

      • urlstring | null
      • sourceobject | null

        The source branch and directory for the rendered Pages site.

        Fields
        • branchstringrequired

          The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages')

        • pathstring | null

          The repository directory from which the site publishes (Default: '/')

    • security_and_analysisobject | null

      Security and analysis settings for the repository. To use this parameter you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository.

      Fields
      • advanced_securityobject | null

        The advanced security configuration for the repository. If a repository's visibility is 'public', advanced security is always enabled and cannot be changed, so this setting cannot be supplied.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable advanced security features on the repository. Can be 'enabled' or 'disabled', This value being present when split licensing is enabled will error out.

      • code_securityobject | null

        The code security configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable code security on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanningobject | null

        The secret scanning configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_ai_detectionobject | null

        The secret scanning AI detection configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning AI detection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_non_provider_patternsobject | null

        The secret scanning non-provider patterns configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning non-provider patterns on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_push_protectionobject | null

        The secret scanning push protection configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning push protection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

    • templateobject | null

      Use a template repository to create this resource.

      Fields
      • include_all_branchesboolean | null

        Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template).

      • ownerstringrequired

        The GitHub organization or user the template repository is owned by.

      • repositorystringrequired

        The name of the template repository.

    • ownerstringrequired

      The organization or user the repository belongs to

      at least 1 character

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

plan

github.repository.planreadsafe to retry

Plan how apply would make a repository match its declaration (or delete it, given none); nothing changes

Input

  • idstring

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

  • desiredrecord of any

    The declared fields; a write-only one may hold a secret marker

Output

  • action"none" | "create" | "update" | "replace" | "delete"required
  • plannedrecord of any
  • unknownstring[]required
  • replacestring[]required

    The fields whose change replaces the object: not empty exactly when replace

create

github.repository.createwrite

Create a repository as declared

Input

  • desiredrecord of anyrequired

    The declared fields; a write-only one may hold a secret marker

Output

  • idstringrequired

    at least 1 character

  • stateobjectrequired
    Fields
    • allow_auto_mergeboolean | null

      Set to 'true' to allow auto-merging pull requests on the repository.

    • allow_forkingboolean | null

      Set to 'true' to allow private forking on the repository; this is only relevant if the repository is owned by an organization and is private or internal.

    • allow_merge_commitboolean | null

      Set to 'false' to disable merge commits on the repository.

    • allow_rebase_mergeboolean | null

      Set to 'false' to disable rebase merges on the repository.

    • allow_squash_mergeboolean | null

      Set to 'false' to disable squash merges on the repository.

    • allow_update_branchboolean | null

      Set to 'true' to always suggest updating pull request branches.

    • archive_on_destroyboolean | null

      Set to 'true' to archive the repository instead of deleting on destroy.

    • archivedboolean | null

      Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving.

    • auto_initboolean | null

      Set to 'true' to produce an initial commit in the repository.

    • default_branchstring | nulldeprecated

      Can only be set after initial repository creation, and only if the target branch exists

    • delete_branch_on_mergeboolean | null

      Automatically delete head branch after a pull request is merged. Defaults to 'false'.

    • descriptionstring | null

      A description of the repository.

    • etagstring | null
    • forkstring | null

      Set to 'true' to fork an existing repository.

    • full_namestring | null

      A string of the form 'orgname/reponame'.

    • git_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository anonymously via the git protocol.

    • gitignore_templatestring | null

      Use the name of the template without the extension. For example, 'Haskell'.

    • has_discussionsboolean | null

      Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'.

    • has_downloadsboolean | nulldeprecated

      Set to 'true' to enable the (deprecated) downloads features on the repository.

    • has_issuesboolean | null

      Set to 'true' to enable the GitHub Issues features on the repository

    • has_projectsboolean | null

      Set to 'true' to enable the GitHub Projects features on the repository. Per the GitHub documentation when in an organization that has disabled repository projects it will default to 'false' and will otherwise default to 'true'. If you specify 'true' when it has been disabled it will return an error.

    • has_wikiboolean | null

      Set to 'true' to enable the GitHub Wiki features on the repository.

    • homepage_urlstring | null

      URL of a page describing the project.

    • html_urlstring | null

      URL to the repository on the web.

    • http_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via HTTPS.

    • idstring | null
    • ignore_vulnerability_alerts_during_readboolean | nulldeprecated
    • is_templateboolean | null

      Set to 'true' to tell GitHub that this is a template repository.

    • license_templatestring | null

      Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'.

    • merge_commit_messagestring | null

      Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message.

    • merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title.

    • namestringrequired

      The name of the repository.

    • node_idstring | null

      GraphQL global node id for use with v4 API.

    • primary_languagestring | null
    • privateboolean | nulldeprecated
    • repo_idnumber | null

      GitHub ID for the repository.

    • source_ownerstring | null

      The owner of the source repository to fork from.

    • source_repostring | null

      The name of the source repository to fork from.

    • squash_merge_commit_messagestring | null

      Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message.

    • squash_merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title.

    • ssh_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via SSH.

    • svn_urlstring | null

      URL that can be provided to 'svn checkout' to check out the repository via GitHub's Subversion protocol emulation.

    • topicsstring[] | null

      The list of topics of the repository.

    • visibilitystring | null

      Can be 'public' or 'private'. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be 'internal'.

    • vulnerability_alertsboolean | nulldeprecated

      Set to 'true' to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on all repos by default). Note that vulnerability alerts have not been successfully tested on any GitHub Enterprise instance and may be unavailable in those settings.

    • web_commit_signoff_requiredboolean | null

      Require contributors to sign off on web-based commits.

    • pagesobject | null

      The repository's GitHub Pages configuration

      Fields
      • build_typestring | null

        The type the page should be sourced.

      • cnamestring | null

        The custom domain for the repository. This can only be set after the repository has been created.

      • custom_404boolean | null

        Whether the rendered GitHub Pages site has a custom 404 page

      • html_urlstring | null

        URL to the repository on the web.

      • statusstring | null

        The GitHub Pages site's build status e.g. building or built.

      • urlstring | null
      • sourceobject | null

        The source branch and directory for the rendered Pages site.

        Fields
        • branchstringrequired

          The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages')

        • pathstring | null

          The repository directory from which the site publishes (Default: '/')

    • security_and_analysisobject | null

      Security and analysis settings for the repository. To use this parameter you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository.

      Fields
      • advanced_securityobject | null

        The advanced security configuration for the repository. If a repository's visibility is 'public', advanced security is always enabled and cannot be changed, so this setting cannot be supplied.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable advanced security features on the repository. Can be 'enabled' or 'disabled', This value being present when split licensing is enabled will error out.

      • code_securityobject | null

        The code security configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable code security on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanningobject | null

        The secret scanning configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_ai_detectionobject | null

        The secret scanning AI detection configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning AI detection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_non_provider_patternsobject | null

        The secret scanning non-provider patterns configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning non-provider patterns on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_push_protectionobject | null

        The secret scanning push protection configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning push protection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

    • templateobject | null

      Use a template repository to create this resource.

      Fields
      • include_all_branchesboolean | null

        Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template).

      • ownerstringrequired

        The GitHub organization or user the template repository is owned by.

      • repositorystringrequired

        The name of the template repository.

    • ownerstringrequired

      The organization or user the repository belongs to

      at least 1 character

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

update

github.repository.updatewrite

Change a repository to match its declaration, replacing it where a field cannot change in place

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

  • desiredrecord of anyrequired

    The declared fields; a write-only one may hold a secret marker

  • expectobject
    Fields
    • action"none" | "create" | "update" | "replace" | "delete"required
    • replacestring[]required

Output

  • idstringrequired

    at least 1 character

  • stateobjectrequired
    Fields
    • allow_auto_mergeboolean | null

      Set to 'true' to allow auto-merging pull requests on the repository.

    • allow_forkingboolean | null

      Set to 'true' to allow private forking on the repository; this is only relevant if the repository is owned by an organization and is private or internal.

    • allow_merge_commitboolean | null

      Set to 'false' to disable merge commits on the repository.

    • allow_rebase_mergeboolean | null

      Set to 'false' to disable rebase merges on the repository.

    • allow_squash_mergeboolean | null

      Set to 'false' to disable squash merges on the repository.

    • allow_update_branchboolean | null

      Set to 'true' to always suggest updating pull request branches.

    • archive_on_destroyboolean | null

      Set to 'true' to archive the repository instead of deleting on destroy.

    • archivedboolean | null

      Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving.

    • auto_initboolean | null

      Set to 'true' to produce an initial commit in the repository.

    • default_branchstring | nulldeprecated

      Can only be set after initial repository creation, and only if the target branch exists

    • delete_branch_on_mergeboolean | null

      Automatically delete head branch after a pull request is merged. Defaults to 'false'.

    • descriptionstring | null

      A description of the repository.

    • etagstring | null
    • forkstring | null

      Set to 'true' to fork an existing repository.

    • full_namestring | null

      A string of the form 'orgname/reponame'.

    • git_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository anonymously via the git protocol.

    • gitignore_templatestring | null

      Use the name of the template without the extension. For example, 'Haskell'.

    • has_discussionsboolean | null

      Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'.

    • has_downloadsboolean | nulldeprecated

      Set to 'true' to enable the (deprecated) downloads features on the repository.

    • has_issuesboolean | null

      Set to 'true' to enable the GitHub Issues features on the repository

    • has_projectsboolean | null

      Set to 'true' to enable the GitHub Projects features on the repository. Per the GitHub documentation when in an organization that has disabled repository projects it will default to 'false' and will otherwise default to 'true'. If you specify 'true' when it has been disabled it will return an error.

    • has_wikiboolean | null

      Set to 'true' to enable the GitHub Wiki features on the repository.

    • homepage_urlstring | null

      URL of a page describing the project.

    • html_urlstring | null

      URL to the repository on the web.

    • http_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via HTTPS.

    • idstring | null
    • ignore_vulnerability_alerts_during_readboolean | nulldeprecated
    • is_templateboolean | null

      Set to 'true' to tell GitHub that this is a template repository.

    • license_templatestring | null

      Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'.

    • merge_commit_messagestring | null

      Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message.

    • merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title.

    • namestringrequired

      The name of the repository.

    • node_idstring | null

      GraphQL global node id for use with v4 API.

    • primary_languagestring | null
    • privateboolean | nulldeprecated
    • repo_idnumber | null

      GitHub ID for the repository.

    • source_ownerstring | null

      The owner of the source repository to fork from.

    • source_repostring | null

      The name of the source repository to fork from.

    • squash_merge_commit_messagestring | null

      Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message.

    • squash_merge_commit_titlestring | null

      Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title.

    • ssh_clone_urlstring | null

      URL that can be provided to 'git clone' to clone the repository via SSH.

    • svn_urlstring | null

      URL that can be provided to 'svn checkout' to check out the repository via GitHub's Subversion protocol emulation.

    • topicsstring[] | null

      The list of topics of the repository.

    • visibilitystring | null

      Can be 'public' or 'private'. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be 'internal'.

    • vulnerability_alertsboolean | nulldeprecated

      Set to 'true' to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on all repos by default). Note that vulnerability alerts have not been successfully tested on any GitHub Enterprise instance and may be unavailable in those settings.

    • web_commit_signoff_requiredboolean | null

      Require contributors to sign off on web-based commits.

    • pagesobject | null

      The repository's GitHub Pages configuration

      Fields
      • build_typestring | null

        The type the page should be sourced.

      • cnamestring | null

        The custom domain for the repository. This can only be set after the repository has been created.

      • custom_404boolean | null

        Whether the rendered GitHub Pages site has a custom 404 page

      • html_urlstring | null

        URL to the repository on the web.

      • statusstring | null

        The GitHub Pages site's build status e.g. building or built.

      • urlstring | null
      • sourceobject | null

        The source branch and directory for the rendered Pages site.

        Fields
        • branchstringrequired

          The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages')

        • pathstring | null

          The repository directory from which the site publishes (Default: '/')

    • security_and_analysisobject | null

      Security and analysis settings for the repository. To use this parameter you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository.

      Fields
      • advanced_securityobject | null

        The advanced security configuration for the repository. If a repository's visibility is 'public', advanced security is always enabled and cannot be changed, so this setting cannot be supplied.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable advanced security features on the repository. Can be 'enabled' or 'disabled', This value being present when split licensing is enabled will error out.

      • code_securityobject | null

        The code security configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable code security on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanningobject | null

        The secret scanning configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_ai_detectionobject | null

        The secret scanning AI detection configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning AI detection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_non_provider_patternsobject | null

        The secret scanning non-provider patterns configuration for this repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning non-provider patterns on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

      • secret_scanning_push_protectionobject | null

        The secret scanning push protection configuration for the repository.

        Fields
        • statusstringrequired

          Set to 'enabled' to enable secret scanning push protection on the repository. Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security.

    • templateobject | null

      Use a template repository to create this resource.

      Fields
      • include_all_branchesboolean | null

        Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template).

      • ownerstringrequired

        The GitHub organization or user the template repository is owned by.

      • repositorystringrequired

        The name of the template repository.

    • ownerstringrequired

      The organization or user the repository belongs to

      at least 1 character

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

delete

github.repository.deletewritesafe to retry

Delete a repository; done already when it is gone

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonetruerequired

generate

github.repository.generatewritesafe to retry

Make a repository from a template repository, through an installation of the GitHub App

Input

  • installationintegerrequired

    The id of the App's installation that acts

    more than 0

  • templateobjectrequired

    The template

    Fields
    • ownerstringrequired

      matches ^(?!\.\.?$)[\w.-]+$

    • repositorystringrequired

      matches ^(?!\.\.?$)[\w.-]+$

  • ownerstringrequired

    The account the new repository belongs to

    matches ^(?!\.\.?$)[\w.-]+$

  • namestringrequired

    The new repository's name

    matches ^(?!\.\.?$)[\w.-]+$

  • privateboolean

    Whether it is private (the default)

    default true

  • descriptionstring

Output

  • idnumberrequired
  • fullNamestringrequired
  • cloneUrlstringrequired
  • sshUrlstringrequired
  • defaultBranchstringrequired

commit

github.repository.commitwritesafe to retry

Commit files (path to text) on top of a branch, through an installation of the GitHub App; a branch not there yet starts from the default branch

Input

  • installationintegerrequired

    The id of the App's installation that acts

    more than 0

  • repositorystringrequired

    The repository, as <owner>/<name>

    matches ^(?!\.\.?\/)[\w.-]+\/(?!\.\.?$)[\w.-]+$

  • branchstringrequired

    at least 1 character

  • messagestringrequired

    at least 1 character

  • filesrecord of stringrequired

    Each file's path and its whole text

Output

  • shastringrequired

    The new commit's

files

github.repository.filesreadsafe to retry

Read files (path to text) of a repository at a ref, through an installation of the GitHub App; a file not there is left out

Input

  • installationintegerrequired

    The id of the App's installation that acts

    more than 0

  • repositorystringrequired

    The repository, as <owner>/<name>

    matches ^(?!\.\.?\/)[\w.-]+\/(?!\.\.?$)[\w.-]+$

  • pathsstring[]required

    The files' paths, from the repository's root

  • refstring

    A branch, tag or commit; the default branch's head when left out

Output

record of string, with no fields.

head

github.repository.headreadsafe to retry

Read the commit a branch is at, through an installation of the GitHub App

Input

  • installationintegerrequired

    The id of the App's installation that acts

    more than 0

  • repositorystringrequired

    The repository, as <owner>/<name>

    matches ^(?!\.\.?\/)[\w.-]+\/(?!\.\.?$)[\w.-]+$

  • branchstringrequired

    at least 1 character

Output

  • shastringrequired

    The branch's head commit

addDeployKey

github.repository.addDeployKeywritesafe to retry

Add an SSH deploy key to a repository, through an installation of the GitHub App

Input

  • installationintegerrequired

    The id of the App's installation that acts

    more than 0

  • repositorystringrequired

    The repository, as <owner>/<name>

    matches ^(?!\.\.?\/)[\w.-]+\/(?!\.\.?$)[\w.-]+$

  • titlestringrequired

    at least 1 character

  • keystringrequired

    The public key, as <type> <base64>

    at least 1 character

  • readOnlyboolean

    Whether it may only fetch (the default)

    default true

Output

  • idnumberrequired

token

github.repository.tokenaccesssafe to retry

Mint an installation token of the GitHub App for one repository alone, with only the permissions named, good for an hour

Input

  • installationintegerrequired

    The id of the App's installation that acts

    more than 0

  • repositorystringrequired

    The repository, as <owner>/<name>

    matches ^(?!\.\.?\/)[\w.-]+\/(?!\.\.?$)[\w.-]+$

  • permissionsrecord of "read" | "write"required

    What the token may do, by GitHub's permission names: { contents: "write" }

Output

  • tokenstringrequired

    The installation token (ghs_…)

  • expiresAtstringrequired

    When its hour is out, as GitHub says

    format date-time, matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

branch_protection

import

github.branch_protection.importreadsafe to retry

Find a branch protection rule by its repository_id:pattern or its binding id and read it; gone when there is none

Input

  • idstringrequired

    at least 1 character

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • allows_deletionsboolean | null

      Setting this to 'true' to allow the branch to be deleted.

    • allows_force_pushesboolean | null

      Setting this to 'true' to allow force pushes on the branch.

    • enforce_adminsboolean | null

      Setting this to 'true' enforces status checks for repository administrators.

    • force_push_bypassersstring[] | null

      The list of actor Names/IDs that are allowed to bypass force push restrictions. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

    • idstring | null
    • lock_branchboolean | null

      Setting this to 'true' will make the branch read-only and preventing any pushes to it.

    • patternstringrequired

      Identifies the protection rule pattern.

    • repository_idstringrequired

      The name or node ID of the repository associated with this branch protection rule.

    • require_conversation_resolutionboolean | null

      Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged.

    • require_signed_commitsboolean | null

      Setting this to 'true' requires all commits to be signed with GPG.

    • required_linear_historyboolean | null

      Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch.

    • required_pull_request_reviewsobject[] | null

      Enforce restrictions for pull request reviews.

      Each item
      • dismiss_stale_reviewsboolean | null

        Dismiss approved reviews automatically when a new commit is pushed.

      • dismissal_restrictionsstring[] | null

        The list of actor Names/IDs with dismissal access. If not empty, 'restrict_dismissals' is ignored. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

      • pull_request_bypassersstring[] | null

        The list of actor Names/IDs that are allowed to bypass pull request requirements. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

      • require_code_owner_reviewsboolean | null

        Require an approved review in pull requests including files with a designated code owner.

      • require_last_push_approvalboolean | null

        Require that The most recent push must be approved by someone other than the last pusher.

      • required_approving_review_countnumber | null

        Require 'x' number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 0-6.

      • restrict_dismissalsboolean | null

        Restrict pull request review dismissals.

    • required_status_checksobject[] | null

      Enforce restrictions for required status checks.

      Each item
      • contextsstring[] | null

        The list of status checks to require in order to merge into this branch. No status checks are required by default.

      • strictboolean | null

        Require branches to be up to date before merging.

    • restrict_pushesobject[] | null

      Restrict who can push to matching branches.

      Each item
      • blocks_creationsboolean | null

        Restrict pushes that create matching branches.

      • push_allowancesstring[] | null

        The list of actor Names/IDs that may push to the branch. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

read

github.branch_protection.readreadsafe to retry

Read a branch protection rule as it is now; gone when it no longer exists

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • allows_deletionsboolean | null

      Setting this to 'true' to allow the branch to be deleted.

    • allows_force_pushesboolean | null

      Setting this to 'true' to allow force pushes on the branch.

    • enforce_adminsboolean | null

      Setting this to 'true' enforces status checks for repository administrators.

    • force_push_bypassersstring[] | null

      The list of actor Names/IDs that are allowed to bypass force push restrictions. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

    • idstring | null
    • lock_branchboolean | null

      Setting this to 'true' will make the branch read-only and preventing any pushes to it.

    • patternstringrequired

      Identifies the protection rule pattern.

    • repository_idstringrequired

      The name or node ID of the repository associated with this branch protection rule.

    • require_conversation_resolutionboolean | null

      Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged.

    • require_signed_commitsboolean | null

      Setting this to 'true' requires all commits to be signed with GPG.

    • required_linear_historyboolean | null

      Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch.

    • required_pull_request_reviewsobject[] | null

      Enforce restrictions for pull request reviews.

      Each item
      • dismiss_stale_reviewsboolean | null

        Dismiss approved reviews automatically when a new commit is pushed.

      • dismissal_restrictionsstring[] | null

        The list of actor Names/IDs with dismissal access. If not empty, 'restrict_dismissals' is ignored. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

      • pull_request_bypassersstring[] | null

        The list of actor Names/IDs that are allowed to bypass pull request requirements. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

      • require_code_owner_reviewsboolean | null

        Require an approved review in pull requests including files with a designated code owner.

      • require_last_push_approvalboolean | null

        Require that The most recent push must be approved by someone other than the last pusher.

      • required_approving_review_countnumber | null

        Require 'x' number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 0-6.

      • restrict_dismissalsboolean | null

        Restrict pull request review dismissals.

    • required_status_checksobject[] | null

      Enforce restrictions for required status checks.

      Each item
      • contextsstring[] | null

        The list of status checks to require in order to merge into this branch. No status checks are required by default.

      • strictboolean | null

        Require branches to be up to date before merging.

    • restrict_pushesobject[] | null

      Restrict who can push to matching branches.

      Each item
      • blocks_creationsboolean | null

        Restrict pushes that create matching branches.

      • push_allowancesstring[] | null

        The list of actor Names/IDs that may push to the branch. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

team_membership

import

github.team_membership.importreadsafe to retry

Find a team membership by its owner/team_id:username or its binding id and read it; gone when there is none

Input

  • idstringrequired

    at least 1 character

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • etagstring | null
    • idstring | null
    • rolestring | null

      The role of the user within the team. Must be one of 'member' or 'maintainer'.

    • team_idstringrequired

      The GitHub team id or the GitHub team slug.

    • usernamestringrequired

      The user to add to the team.

    • ownerstringrequired

      The organization the team is in

      at least 1 character

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

read

github.team_membership.readreadsafe to retry

Read a team membership as it is now; gone when it no longer exists

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • etagstring | null
    • idstring | null
    • rolestring | null

      The role of the user within the team. Must be one of 'member' or 'maintainer'.

    • team_idstringrequired

      The GitHub team id or the GitHub team slug.

    • usernamestringrequired

      The user to add to the team.

    • ownerstringrequired

      The organization the team is in

      at least 1 character

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

repository_deploy_key

import

github.repository_deploy_key.importreadsafe to retry

Find a deploy key by its repository:key or its binding id and read it; gone when there is none

Input

  • idstringrequired

    at least 1 character

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • etagstring | null
    • idstring | null
    • keystringrequired

      A SSH key.

    • read_onlyboolean | null

      A boolean qualifying the key to be either read only or read/write.

    • repositorystringrequired

      Name of the GitHub repository.

    • titlestringrequired

      A title.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

read

github.repository_deploy_key.readreadsafe to retry

Read a deploy key as it is now; gone when it no longer exists

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • etagstring | null
    • idstring | null
    • keystringrequired

      A SSH key.

    • read_onlyboolean | null

      A boolean qualifying the key to be either read only or read/write.

    • repositorystringrequired

      Name of the GitHub repository.

    • titlestringrequired

      A title.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

plan

github.repository_deploy_key.planreadsafe to retry

Plan how apply would make a deploy key match its declaration (or delete it, given none); nothing changes

Input

  • idstring

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

  • desiredrecord of any

    The declared fields; a write-only one may hold a secret marker

Output

  • action"none" | "create" | "update" | "replace" | "delete"required
  • plannedrecord of any
  • unknownstring[]required
  • replacestring[]required

    The fields whose change replaces the object: not empty exactly when replace

create

github.repository_deploy_key.createwrite

Create a deploy key as declared

Input

  • desiredrecord of anyrequired

    The declared fields; a write-only one may hold a secret marker

Output

  • idstringrequired

    at least 1 character

  • stateobjectrequired
    Fields
    • etagstring | null
    • idstring | null
    • keystringrequired

      A SSH key.

    • read_onlyboolean | null

      A boolean qualifying the key to be either read only or read/write.

    • repositorystringrequired

      Name of the GitHub repository.

    • titlestringrequired

      A title.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

update

github.repository_deploy_key.updatewrite

Change a deploy key to match its declaration, replacing it where a field cannot change in place

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

  • desiredrecord of anyrequired

    The declared fields; a write-only one may hold a secret marker

  • expectobject
    Fields
    • action"none" | "create" | "update" | "replace" | "delete"required
    • replacestring[]required

Output

  • idstringrequired

    at least 1 character

  • stateobjectrequired
    Fields
    • etagstring | null
    • idstring | null
    • keystringrequired

      A SSH key.

    • read_onlyboolean | null

      A boolean qualifying the key to be either read only or read/write.

    • repositorystringrequired

      Name of the GitHub repository.

    • titlestringrequired

      A title.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

delete

github.repository_deploy_key.deletewritesafe to retry

Delete a deploy key; done already when it is gone

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonetruerequired

repository_collaborator

import

github.repository_collaborator.importreadsafe to retry

Find a collaborator by its repository:username or its binding id and read it; gone when there is none

Input

  • idstringrequired

    at least 1 character

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • idstring | null
    • invitation_idstring | null

      ID of the invitation to be used in 'github_user_invitation_accepter'

    • permissionstringrequired

      at least 1 character

    • permission_diff_suppressionboolean | null

      Suppress plan diffs for triage and maintain. Defaults to 'false'.

    • repositorystringrequired

      The GitHub repository

    • usernamestringrequired

      The user to add to the repository as a collaborator.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

read

github.repository_collaborator.readreadsafe to retry

Read a collaborator as it is now; gone when it no longer exists

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonebooleanrequired
  • stateobject
    Fields
    • idstring | null
    • invitation_idstring | null

      ID of the invitation to be used in 'github_user_invitation_accepter'

    • permissionstringrequired

      at least 1 character

    • permission_diff_suppressionboolean | null

      Suppress plan diffs for triage and maintain. Defaults to 'false'.

    • repositorystringrequired

      The GitHub repository

    • usernamestringrequired

      The user to add to the repository as a collaborator.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

plan

github.repository_collaborator.planreadsafe to retry

Plan how apply would make a collaborator match its declaration (or delete it, given none); nothing changes

Input

  • idstring

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

  • desiredrecord of any

    The declared fields; a write-only one may hold a secret marker

Output

  • action"none" | "create" | "update" | "replace" | "delete"required
  • plannedrecord of any
  • unknownstring[]required
  • replacestring[]required

    The fields whose change replaces the object: not empty exactly when replace

create

github.repository_collaborator.createwrite

Create a collaborator as declared

Input

  • desiredrecord of anyrequired

    The declared fields; a write-only one may hold a secret marker

Output

  • idstringrequired

    at least 1 character

  • stateobjectrequired
    Fields
    • idstring | null
    • invitation_idstring | null

      ID of the invitation to be used in 'github_user_invitation_accepter'

    • permissionstringrequired

      at least 1 character

    • permission_diff_suppressionboolean | null

      Suppress plan diffs for triage and maintain. Defaults to 'false'.

    • repositorystringrequired

      The GitHub repository

    • usernamestringrequired

      The user to add to the repository as a collaborator.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

update

github.repository_collaborator.updatewrite

Change a collaborator to match its declaration, replacing it where a field cannot change in place

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

  • desiredrecord of anyrequired

    The declared fields; a write-only one may hold a secret marker

  • expectobject
    Fields
    • action"none" | "create" | "update" | "replace" | "delete"required
    • replacestring[]required

Output

  • idstringrequired

    at least 1 character

  • stateobjectrequired
    Fields
    • idstring | null
    • invitation_idstring | null

      ID of the invitation to be used in 'github_user_invitation_accepter'

    • permissionstringrequired

      at least 1 character

    • permission_diff_suppressionboolean | null

      Suppress plan diffs for triage and maintain. Defaults to 'false'.

    • repositorystringrequired

      The GitHub repository

    • usernamestringrequired

      The user to add to the repository as a collaborator.

  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

delete

github.repository_collaborator.deletewritesafe to retry

Delete a collaborator; done already when it is gone

Input

  • idstringrequired

    at least 1 character

  • staterecord of any
  • handlestring

    The driver's data for the object, opaque: pass it back unchanged

Output

  • idstringrequired

    at least 1 character

  • gonetruerequired

These pages describe sanoma 0.11.24.