As of February, 2024 you can connect your Pegasus projects directly to Github instead of downloading them as a zip file. This makes for a more streamlined workflow---especially when changing or upgrading your project.
The following video shows how to create and update a project using the Github integration.
There are two ways to connect your Github account. The Oauth-based "Connect Github" option is easier and more reliable, while personal access token option allows you to control exactly what repositories Pegasus can access.
The easiest way to connect your account is by using the "Connect Github" button on the project download page. You will be prompted to accept permissions, and your account will be connected in a few seconds.
Note: While you will be prompted to grant access to "all private repository data," Pegasus does not view or modify data in any repositories unless you connect them.
If you prefer not to grant Pegasus access to your entire Github account, you can use Personal Access Tokens to limit the scope of what Pegasus has access to.
To use Pegasus with a classic token, visit the Personal access tokens page on Github, then select "Generate new token (classic)" from the dropdown, or visit this page.
Choose a note and expiration date for your token and grant the following scopes:
- user:email (Access user email addresses (read-only))
- repo (Full control of private repositories)
- workflow (Update GitHub Action workflows)
Then click "Generate token". You will be taken to a page where your token is displayed. Copy this value and paste it into the "personal access token" field from your project download page on Pegasus. Note that you won't be able to view the token again!
If you want the most control over your permissions, you should use a fine-grained access token, which allow you to control access to specific repositories.
Note that if you use fine-grained tokens you must create the repository for your project before creating the token. Pegasus cannot create the project for you with these tokens.
After creating the repository, create a new fine-grained-token from this page. Set a token name and expiration date, and then use "Only select repositories" to choose the repositories you want to grant access to (the one you just created).
Under "Permissions" --> "Account Permissions" you must grant read access to:
- Email addresses
Then under "Permissions" --> "Repository Permissions" you must grant read and write access to:
- Contents
- Pull Requests
- Workflows
Then click "Generate token". You will be taken to a page where your token is displayed. Copy this value and paste it into the "personal access token" field from your project download page on Pegasus. Note that you won't be able to view the token again!
Projects that were created before February 2024, or that didn't use the Github integration can still be connected to Github via a one-time process. After completing this, you will be able to upgrade and change your Pegasus project using automatic pull requests.
First, you'll have to connect your Github account using one of the methods described above.
Next, you will need to find the commit id of the last Pegasus update you have made.
If you have never updated your codebase, this will be the first commit in the repository, which you can
find by running git log --reverse.
If you have updated your codebase using one of the other methods below, this will be the last commit
on the pegasus branch of your repository, which you can find by running git checkout pegasus followed by git log.
Once you have the commit id ready, add your existing Github repository to your Pegasus project from the downloads page. After completing this step you will be prompted with a page that looks like this:
Enter the commit ID there, and you should now be able to update your project with pull requests.
Github organizations do not allow API-based repository access by default, so to connect a repository owned by an organization you will also have to grant programmatic access.
Github provides detailed guidance on how to do this. For "Connect Github," follow the oauth instructions, and for personal access tokens, follow the personal access token instructions.
I keep getting "Error pushing to GitHub. Please check your token scopes." when pushing my project.
While Pegasus does its best to catch errors that come from Github and show them to you, sometimes it will return this generic error.
One common reason a valid token is unable to push code is related to email privacy settings. Specifically the "Blocking command line pushes that expose your personal email address" setting---which currently must be disabled in order to use the Github integration.
To check and disable this setting:
- Go to your Github email settings
- Scroll down to where it says "Keep my email addresses private".
- If that option is checked, ensure that the "Block command line pushes that expose my email" option below it is not checked.
- If that option is not checked, then it is a different problem. You are welcome to reach out directly for support