Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Repositories / Repositories Get Info

  • Article
  • 3 minutes to read

Operation Information

Retrieves information about a repo.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type GitHub.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose GitHub in the Type pick list;
  • Give the GitHub KeySafe key a Title (this is the name / identifier for the GitHub account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked GitHub account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Owner or Organization owner string Owner or organization of the repo Yes None provided
Name name string Name of the repo Yes None provided

Output Parameters

Display Name ID Type Description
API URL api string The API URL for the repo
Fullname fullname string The full name of the repo
HTML URL html string The HTML URL for the repo
Id id number The id of the repo
Name name string The name of the repo
Owner owner string The owner of the repo
Owner description string The Description of the repo
Homepage homepage string The homepage of the repository retrieved
Language language string The language the repository was committed in
Fork Count forks_count number The number of forks on a repository
Stargazer Count stargazers_count number The number of people who have starred the repository
Watchers Count watchers_count number The number of people watching the repository
Size size number The size of the repository
Default Branch default_branch string The default branch of the repository
Open Issues Count open_issues_count number The number of open issues on the repository
Has Issues has_issues boolean A true or false statement on if there are any issues against the repository
Has Wiki has_wiki boolean A true or false statement on if the repository is documented on wikipedia
Has Pages has_pages boolean A true or false statement if it has pages showcasing open source projects
Has Downloads has_downloads boolean A true or false statement on if the repository has been downloaded
Pushed At pushed_at string The date time of when the repository was pushed at
Created At created_at string The date time of when the repository was created
Updated At updated_at string The date time of when the repository was updated
Allow Rebase Merge allow_rebase_merge boolean Controls wether the repository can be rebased and merged
Allow Squash Merge allow_squash_merge boolean Controls wether a repository can be squash merged
Allow Merge Commit allow_merge_commit boolean Controls wether a merge commit can be made against this repository
Subscribers Count subscribers_count number The number of subscribers against the repository
Network Count network_count number The number of networks against this repositroy
Organsiation ID organization string The unique ID of the organization within GitHub
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document