📘

This functionality is currently in active development and will be rolled out iteratively over the following couple of months (June 2024)

Overview

Users of the Pennsieve Platform can link their GitHub account to their Pennsieve profile. This enables users to:

1. Register GitHub repositories as Pennsieve applications
2. Publish GitHub repositories to generate a public landing page and citation DOI.

Integration of GitHub and Pennsieve allows for seamless interaction of data and analysis on the platform and supports an integrative approach to publishing both data and code in a meaningful way.

Installing the Pennsieve GitHub Integration

You can register your GitHub account with your Pennsieve profile by going to your profile on the Pennsieve platform. Click on "My Workspace" in the left main menu and scroll down to the GitHub section:

When you click on "Register your GitHub Account", you will be redirected to GitHub to authenticate and to install the Pennsieve GitHub Application in your GitHub account. Here you can select whether you want Pennsieve to track all your repositories or a select set of repositories. By allowing Pennsieve to track repositories, it can automatically trigger publishing a repository on new releases, or update Pennsieve Applications.

Once you agree to install and authorize, your accounts are linked and you'll be able to manage publishing repositories and applications through your Pennsieve account.

Removing the Pennsieve GitHub integration

You can un-install the Pennsieve GitHub integration and unlink your account by clicking on the "x" next to your GitHub user-name. This will bring up a window where you need to confirm uninstalling the application. After un-installing the Pennsieve GitHub Application, Pennsieve will no longer receive events from your GitHub account and you will be unable to update applications, or publish repositories.