Difference between revisions of "GitHub"

From Hornbill
Jump to navigation Jump to search
(Replaced content with "This document can now be found at its new location in the [https://docs.hornbill.com/ibridge-packages/welcome Hornbill Document Library]. file:hornbill-document-lib...")
Tag: Replaced
Line 1: Line 1:
 +
This document can now be found at its new location in the [https://docs.hornbill.com/ibridge-packages/welcome Hornbill Document Library].
  
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
+
    [[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/ibridge-packages/welcome]]
__NOTOC__[[Main Page|Home]] > [[Integration]] > [[Business Process Automation & Orchestration]] > [[Hornbill iBridge]] > GitHub
 
</div>
 
{|style="width: 100%"
 
|- valign="top"
 
|style="width:73%"|
 
[[File:GitHub_Logo.png|200px]]
 
<br>
 
==Introduction==
 
GitHub is a web-based hosting service for software development projects that use the Git revision control system.
 
 
 
|style="width:5%"|
 
|
 
|style="width:22%; border-style: solid; border-width: 1px; border-color:#e6e6e6; background-color:#f2f2f2;"|
 
 
 
== Related Articles ==
 
:* [[Hornbill iBridge]]
 
:* [[Hornbill_KeySafe|KeySafe]]
 
:* [[Integration Call]]
 
:* [[Business_Process_Designer|Business Process Designer]]
 
|}
 
 
 
==KeySafe Configuration==
 
[[File:github_keysafe.png|300px|right]]
 
[[File:github_login.png|300px|right]]
 
[[File:github_permissions.png|300px|right]]
 
 
 
In order to integrate with GitHub, you will first need to configure, and securely store the authentication credentials for the GitHub Account/s you want to use with the Hornbill App.
 
 
 
Configure your '''GitHub''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''' in order to use the GitHub options.  
 
 
 
In the admin console > System > Security > KeySafe
 
 
 
* Select on '''+''' and select '''GitHub'''
 
* Give the GitHub KeySafe a Title (this is the name/identifier for the GitHub account as you will see it when using the Integration Call node in your business process or custom button)
 
* Optionally add a description
 
* Select '''Create Key''' to save
 
 
 
Once the Key is created, you will need to connect to GitHub and your account, in order to authorize the Hornbill App to perform the listed GitHub options.
 
 
 
* Select '''Connect'''
 
 
 
You will be redirected to GitHub in a pop-up window, where you will be required to log in to your GitHub account, and then you will be prompted to review the options you are authorising the Hornbill App to be allowed to perform with the chosen GitHub account, read and then select '''Allow'''
 
 
 
 
 
'''Managing GitHub Configurations'''
 
 
 
* Use KeySafe to create, store and enable GitHub account in KeySafe in order to revoke authentication rights for the Hornbill App to use the account. Note:
 
** This will revoke the rights of any existing GitHub Integration Calls in your business processes or Custom Buttons, which are using the revoked GitHub Account, so you will need to edit these accordingly.
 
<br/>
 
<br/>
 
 
 
==Business Process and Custom Buttons==
 
===Options (Methods)===
 
Once you have your GitHub Account Authorised, you're all set to use it with the '''[[Integration Call]]''' in your business processes or '''[[Custom Buttons]]'''.  The following options are now available for you to use within GitHub:
 
 
 
* Gists
 
** File Add
 
** File Get
 
** File Remove
 
** File Rename
 
** File Update
 
** Gist Create
 
** Gist Delete
 
** Gist Fork
 
** Gist Get Info
 
** Gist Update
 
* Issues
 
** Issue Add Comment
 
** Issue Create
 
** Issue Get Details
 
** Issue Update
 
* Repositories
 
** Commit Add Comment
 
** Commit Get latest
 
** File Add
 
** File Get
 
** File Remove
 
** File Update
 
** Repositories Create
 
** Repositories Get Info
 
 
 
 
 
Read more about using the '''[[Integration Call]]''' from the Related Articles section, and learn how to work with input and output parameters for each of the GitHub options.
 
 
 
[[Category:Integration]]
 

Revision as of 18:20, 18 January 2024

This document can now be found at its new location in the Hornbill Document Library.

   Hornbill Cloud