GitHub Campus: ReadMe

Tags ReadMe GitHub

St. Thomas GitHub Campus - Read Me First

The St. Thomas GitHub Campus organization is located at: https://github.com/orgs/UniversityOfSaintThomas/ 

Welcome! Whether you are ITS, other staff, faculty, or student, you are welcome to use our GitHub to store your computer code and other collaborative work.

Purpose

This GitHub organization allows individuals and teams throughout the St. Thomas community to easily store code in a central St. Thomas hub; to seamlessly share code with anyone at St. Thomas; and to make collaboration on code projects a breeze, whether within a single classroom or across multiple colleges.

How It Works

GitHub and Git

If you are new to Git and GitHub, learn more with GitHub's guides and labs. It can also be helpful to explore training for Git, the technology at the heart of GitHub.

Logging in

Our GitHub Campus works by linking users' GitHub accounts to their St. Thomas accounts. When you first try to log in, go to https://github.com/orgs/UniversityOfSaintThomas/sso. You will be prompted to log into both your St. Thomas account and your GitHub account. (You will be prompted to create a GitHub account if you do not already have one.) After that, your accounts will remain permanently linked. Anyone with a valid St. Thomas account (including xtra- accounts) can join our GitHub Campus organization.

After you log in, you can visit our GitHub Campus organization directly at https://github.com/orgs/UniversityOfSaintThomas/. You can also access your St. Thomas repos to from your personal dashboard at https://github.com/

The First Time You Log In

The first time you log in, you can immediately start using the St. Thomas GitHub. However, it may take up to an hour for your account to be automatically added to all the teams you're supposed to be a member of. Thus, you may not see all the repos you expect to see right away. Log out and come back in an hour, and all your access should be correctly assigned.

Command Line login

If you are not using git from your command line or terminal, or if you don't know what that means, you can skip this section.

Because our GitHub Campus organization enforces SSO signin for all users, you can't simply run git push, enter your credentials, and have it work. You will need to first set up a Personal Access Token unique to your account, give it permission to touch your repos, assign it SSO access to the University of Saint Thomas organization, and use the token as your GitHub password (from the command line) going forward. Follow GitHub's guide: Creating a personal access token for the command line. How to hook this into your Git Credentials Manager (assuming you use it) is a bit more of a personal question, but you may find these two StackOverflow answers helpful.

Repositories

repository (or "repo") is a project folder that contains all the information about a project, including not just files, but discussions, management options, and records of all changes ever made, who made them, and when. Most people work on repos by "cloning" (copying) the GitHub repo to their personal computer, making changes there, and then "pushing" (uploading) their work back to the GitHub repo. More on this in the Git documentation.

If you have access to any existing St. Thomas repositories, you can see them here: https://github.com/UniversityOfSaintThomas. Repository management in GitHub Campus is largely the same as it is in regular GitHub, with a couple of small exceptions.

Structure

The St. Thomas organization is the owner of all repositories stored within the org. The creator of a repository is its default admin. The admin decides which other teams and individuals can access the repository and exactly how much control to grant them.

Repository Creation

You can create a repository by following GitHub's instructions, or by visiting the St. Thomas GitHub Campus homepage and clicking the green "New" button in the upper-right corner. You are free to create and manage as many repos as you want.

It is important that you set the Owner to UniversityOfSaintThomas, not your personal account. If you do not, the repo will not be part of the St. Thomas organization and will not be able to make use of any of our GitHub Campus features. (You will still be admin on any repos you create.)

Repository Visibility

Repositories can be publicinternal, or private.

Private repos

A private repo is visible only to the teams and individuals you choose. This is the appropriate setting for most repos at St. Thomas.

Public repos

A public repo is visible to everyone in the world, making it "open source." You should not use this setting unless you know what you are doing.

You should carefully review the repo to ensure it includes no Yellow or Red data (according to the St. Thomas data classification policy), attach the appropriate licenses, and obtain any required clearances. (Specific requirements vary by department and division.)

Internal repos

An internal repo is visible to everyone within the St. Thomas community, and no one else. This does not require licensing or clearances, but, since you'll be sharing your repo with 15,000 St. Thomas faculty, staff, employees, and others, you should still be careful to follow the data classification policy. Since internal repos show up on everyone's dashboard, ITS may curate these and set them to Private at ITS's discretion.

This ReadMe is an example of an internal repo.

Managing Repository Access

If you are admin on a repository, you can enter the repo, click the Settings tab, then select Manage Access from the left sidebar to "invite" individuals or teams to your repo. You can assign different levels of access to different teams; the access levels are described by Git, and range from simple read-only access to full admin rights.

Importing a Repository

Since St. Thomas's GitHub Campus is so new, you may already have St. Thomas-related repos that exist outside the St. Thomas GitHub Campus organization. You can transfer ownership of a repository from your personal account to the St. Thomas organization by following these instructions.

When you transfer a repo to St. Thomas ownership, your admin rights are downgraded to write access. This is an annoying quirk. The GitHub Campus Administrator (currently me, James Heaney) will receive a notification whenever this happens and will restore your admin rights in a timely manner.

Some users prefer to avoid this issue by creating a new repo within the St. Thomas org (so they have admin rights), then pushing their old personal repo to the new St. Thomas repo, then finally deleting the old repo.

Teams

The St. Thomas organization contains a number of teams. Teams offer a way for specific individuals to discuss and collaborate among themselves, and they are a marvelously convenient way to manage permissions for repositories.

For example, if you have 12 repos you want to share with another unit at St. Thomas, and that unit has 15 members, you can either add each member to each repo individually (and go through every repo again when Linda gets promoted out and they hire Leonard)... or you can assign access to that unit's GitHub team, and let them manage their team's changes. You'll almost always want to manage access to repos using teams instead of individual accounts.

You can view the existing teams here: https://github.com/orgs/UniversityOfSaintThomas/teams. At this writing, ITS has created only a few very broad teams, but more will be added as more groups start using GitHub Campus.

Team Creation Etiquette

Any user of the St. Thomas GitHub Campus Organization is free to create and manage teams -- as many as you want. You can do so by visiting the Teams page and clicking the green "New team" button in the top right corner.

We request that any teams you create be set to Secret (not Visible). The list of Visible teams is curated by ITS.

ITS is available to help you set up your teams -- especially if you would like to create a Visible team. Email techdesk@stthomas.edu and note in the email that the ticket should be sent to the GitHub Campus Administrator, James Heaney.

A new team must be configured to be synchronized or unsynchronized. Here is what that means:

Synchronized Teams

A synchronized team is connected to a specific St. Thomas Active Directory group (like "Group: Chess Club" or "Biology Faculty and Staff DG"). GitHub Campus "syncs" with St. Thomas Active Directory once every hour and automatically updates the members of your synchronized GitHub Campus team. Anyone who has joined the A.D. group is added to the team; anyone who is no longer in the A.D. group is removed. This means you don't have to deal with constantly managing team membership when new employees or students are hired and others depart; Active Directory handles all that behind-the-scenes.

If you are a team's admin (or are creating a team), you can connect it to a St. Thomas Active Directory group using the Identity Provider Groups option in the team's Settings >> General tab (or on the team creation screen). The Identity Provider Groups lookup menu searches A.D. for groups that match what you've typed in.

Tip: The lookup menu is not a freeform search, but a quite rigid lookup; if the group you are looking for is called "Group: UST Chemistry Department Stockroom," you must type in "Group: UST Chem" to find it. Typing in just "Chemistry" will not find it.

Active Directory Groups

You can find a list of the most commonly-used A.D. groups in Outlook People Online under Directory >> All Distribution Groups (on the left sidebar).

Some of these groups are managed automatically by ITS using Banner data. Those groups start with the prefixes "Auto:", "Staff:" and "Acad:". You can find more information about them on our Automated Email Distribution Groups page, and you can easily search for them using Outlook people search. For example, if you want all full-time faculty in the School of Engineering to be members of a team, you would connect the team to "Auto: Faculty - Full-Time - School of Engineering."

Other groups, especially the ones with the "Group:" prefix, are managed manually by Outlook group owners. You can create an Outlook group yourself by visiting Outlook People. In the upper-left corner, there is a purple button that says "New Contact." Click the dropdown arrow on the right side of the button and select "New Group."

Unsynchronized Teams

An unsynchronized team is created in GitHub but not connected to any St. Thomas group. The team's admin must manually manage its member list within GitHub campus. This is done through the team's Members tab. It is simpler to set up initially, but more arduous to manage. Unsynchronized teams may also have child teams. (Synchronized teams may not.)

Need help?

ITS is available to provide any assistance that you may need with the St. Thomas GitHub. Email techdesk@stthomas.edu to open a support ticket (cc jjheaney@stthomas.edu).

Details

Article ID: 112731
Created
Tue 7/28/20 10:40 AM
Modified
Thu 2/4/21 10:22 AM