Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please note that a valid GitHub ID is mandatory. If you don’t have a GitHub id, you can get one for free by clicking here.

Creating a repository

GitHub integration pre-checks

There are 3 important steps to cover in order to use your GitHub repository with StagingPro:

  1. Check your GitHub repository is created under user type ‘Organisation’

  2. Your GitHub repository should have already selected the ‘Add a README’ file. Otherwise you should create a new repo with the option checked

  3. Add stagingpro as an approved ‘Admin’ collaborator to your GitHub repository

These should be validated, *before* you link your GitHub repository with your StagingPro environment

Check your GitHub repository is created under user type ‘Organisation’

The first thing to make sure of is that the your repository is created under the user type “Organisation” ‘Organisation’ (https://github.com/settings/organizations) and not under a Personal Account type. If you do not yet have an organization account, then you can follow the GitHub documentation on this subject. To do this, navigate to your repositories and click “New.”

...

Enter a suitable “Repository Name” (as an example - stagingprod testrepo)

It is recommended that the repository should be ”Private.”

...

Click “Create Repository”

...

...

Add stagingpro as an approved ‘Admin’ collaborator to your GitHub repository

You are now sitting with a repository with no branches, and we need to add collaborators. To do this, click on “Settings.”

...

You have now created a collaborator which has the status of “Pending Invite”. And the invitation has now been sent to StagingPro

...

Link your GitHub repository with your StagingPro environment

For StagingPro to accept the invite, you must click on the “ <> Code” icon in the menu tab and copy the page URL

...