How to connect ORDO with your GitHub account

You can get set up in the applications section, which can be accessed by clicking on your profile icon in the top right hand corner of the screen.

Under "Integrations" click "Connect" under the GitHub icon.

You'll be redirected to sign in to your GitHub account where you'll authorise Figshare (ORDO).

Click off the Configure GitHub Integration overlay, go to My Data and click on the GitHub icon (that shows up after hovering the cursor on the GitHub symbol):

You can then start importing from GitHub from your list of public repositories:

If your repository has multiple releases, you can choose which is the first release you'd like to import. You can choose to select multiple items at the same time and each GitHub will create its own ORDO item.

Upon import, the system will automatically choose the article type, add a reference back to the original GitHub item, import the description and title from GitHub and set the default licence to MIT.

A key aspect of setting up GitHub via the applications section is that you can edit the auto-sync global settings for your GitHub integration. If you configure the auto-sync setting to ON, the system will automatically update for every release (for each of your imported repos) and this will only occur if your ORDO item is public. Each new release would generate a new version of your ORDO item.

Please note: ORDO will only create a new version for a release and not a single commit.

If you have something to upload straight away you can access the GitHub integration directly from My Data. From My Data, select Import from GitHub, as shown above. Then select Connect and you'll see and overlay with the public repositories available to import.

GitHub Upload Action

To help automate the publication step in GitHub-based research workflows, Figshare has released the Figshare upload GitHub Action. You can incorporate the upload Action into your GitHub workflows and push your files into Figshare directly from GitHub. For details regarding the Action setup visit the GitHub repo page.