Git for Academia

A seminar for the casual git user…

A course provided by

Authors

Dr. Jonas I. Liechti
Dr. Matteo Delucchi

Editors

Barbara Mejia

Content

About

• About this Seminar
  • Syllabus

Part 1: Working with Git

• - A Brief Introduction
  • What is ?
  • Main Features
  • Limitations
• - Basic Elements
• .gitignore
  • What is .gitignore?
  • Why is it Useful?
  • Historical Context
  • When to Use .gitignore
  • Pattern Syntax
  • Best Practices
  • Debugging & Common Issues
• - Elementary commands
• The Update Cycle
• - History
  • The -Historian’s Toolset
  • The -Editors’s Toolset
• Collaboration Principles
  • Healthy Reference
  • Separate Changes
  • Meaningful Steps
  • Flag States
• ✨Feature✨ Branch Approach
• Versioning
  • Semantic Versioning
• Useful Commands
• Exercise

Part 2: Git and its Remotes

• Remote Services
  • Non-Exhaustive Overview of Hosting Services
• Popular Remotes
• Remote Services in Detail
  • GitHub
  • GitLab
• Remote Services at the University of Zurich
  • I-MATH GitLab Server
  • UZH GitLab Server
  • UZH GitHub
• GitHub Education
• Remote Features
  • Universal Features
  • Web Interface
  • Collaboration Tools
  • Access Control
  • Continuous Integration & Continuous Deployment (CI/CD)
• Project Management
  • + Remote Tools Interactions
  • Feature Branch Approach - reloaded
• Organizing Projects
  • Challenges in Research Groups
  • GitHub’s Organization Structure
  • GitLab’s Organization Structure
  • Differences Between GitHub and GitLab
• Contributing to 🔓 Open Source Repositories
  • Step-by-Step
• Further Topics Not Covered
• Exercise

Part 3: CI/CD Workflows

• Why 🤖 Automation?
  • Harnessing the Power of Automation
  • The Benefits for Non-Software Developers
  • The Challenges of Automation
• Creating CI/CD Scripts
  • A YAML Primer
  • Understanding Variable Substitution
  • From YAML to Automation
  • GitHub Workflows
  • Recap: Weekend Out Exercise
  • GitLab Pipelines
  • Workflows vs. Pipelines - Overview
  • Workflows vs. Pipelines - by Example
• Runners
  • What Are Runners in CI/CD?
  • Types of Runners
  • Configuring Runners
  • Communication with Remote Service
• 🤗 Embrace automation 🤗
  • Recap
  • Feature Branch Approach - with Automation
  • Some considerations
• Exercise
  • LaTeX Article CI/CD Pipeline

Part 4: Git and Science

• in Science
  • A Historical Perspective
• Project Management Tools
  • Key Features and Benefits
  • Advanced & Features
  • Example: Paper Review on or
• Large File Storage (LFS)
  • Why Use LFS?
  • vs. LFS: A Comparison
• Data Model
  • How does Track Files?
  • How LFS Tracks Large Files
  • How to use LFS
  • LFS Availability at UZH
• Submodules
  • What are Submodules?
  • Features of Submodules
  • Benefits for Reproducibility
  • Use Cases
  • Essential Commands
  • Working with Submodules
  • Gotchas for Submodules
  • Handling Submodules in CI/CD Pipelines
  • Exercise: The Course Content Structure
• Versioning ⚡️Reproducibility
  • Reproducibility
  • Where and its Remote Services Can Help
  • How Can Enhance Reproducibility
  • Can Do More!
  • … and More!
  • How Remote Services Can Enhance Reproducibility
• Exercise

Outro

• Outro
  • Content
  • Instructors
  • About