hrk/Braid-slides
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
Braid-slides/slides.rst
Heerko 7caf227316 git pull
2026-01-15 14:53:23 +01:00

862 lines
19 KiB
ReStructuredText
Raw Blame History

:title: 🪢 Braids 🪢 Intro to git
:author: H&D
:description:
:css: slides.css
.. header::
🪢 Braids 🪢 Introduction to git 🪢 with H&D 🪢
----
🪢 Braids: Intro to git 🪢
============================
.. image:: assets/images/qr_hd.jpg
:width: 150px
:scale: 100 %
.. note::
Goal: introduce Git as an archiving practice,
then do a little branch-based website exercise published live.
----
Planning (90 min)
=================
1. Context: what git is, what it does, who uses it (5 min)
2. Core concepts (20 min)
3. Recap (5 min)
4. Install Git (10 min)
5. Core commands (15 min)
6. Exercise: accounts + clone/push permissions (10 min)
7. Exercise: branch a page, publish live, iterate (20 min)
8. Wrap-up & next steps? (5 min)
..
----
Workshop outcome
================
Each participant will:
- have basic knowledge of git
- clone a repository
- create a branch
- commit changes
- push branch to our platform
----
Why git?
================
If you have been working on a file on your computer and the directory starts to look like this:
.. code-block:: bash
motivation-letter-first-draft.odt
motivation-letter.odt
motivation-letter-less-formal.odt
motivation-letter-less-formal-comments-HvK.odt
motivation-letter-less-formal-comments-HvK-LS.odt
motivation-letter-FINAL.odt
motivation-letter-FINAL-pictures.odt
motivation-letter-FINAL-pictures-small.odt
Then git can be helpful!
.. note::
this file has different chronological versions, features and collaborators, 3 things git is great at.
----
What is git?
============
- git is a distributed **version control system**
- git **tracks changes over time** to files inside a folder
- git operates in a **hidden sub-folder** inside the tracked folder
- git enables **traceability** across time (history), collaboration (authorship) and experimentation (branches)
.. note::
is the archive analogy helpful? it feels a bit like comapring something abstract with something else thats abstract
Archiving analogy:
- commit = deposit with metadata
- log = inventory / finding aid
- branch = parallel dossier / alternative interpretation
----
What is git not?
================
- git ≠ Github!
- git ≠ backup system (though it can help)
- git ≠ file sync tool (though it can be used like that)
- git ≠ CMS (though we use it like that today)
- git ≠ magic: it records changes, you still choose what to record
.. note::
we will see today that is git is best suited for text-based projects, especially when parsing the text is particularly useful
it's not a good choice for recording history on very large files (such as videos) or files where the raw textual data is illegible
----
Ecosystem
=========
- **git**: the version control system itself
- **git hosts**: platforms where git repositories are hosted
- GitHub, Bitbucket, GitLab (operated by Big Tech Giants)
- Alternatives
- Codeberg (non-profit, community led)
- Oxacab (riseup.net for activists, journalists)
- Forgejo / Gitea (self-hosted)
- **git clients**: tools used to work with git on your computer
- ``git`` command line tool (free & open source)
- ``tig`` command line tool (free & open source)
- sourcetree, Github Desktop, VS Code (operated by Big Tech)
- many code editors (e.g. sublime, atom) have git extensions
- many, many more tools and extensions
----
Core concept: Commits
=====================
.. container:: row
.. container::
In git, a **commit** is a checkpoint in the repository timeline.
A commit contains this information:
1. **What** changes have taken place?
2. **Who** made these changes?
3. **When** were the changes made?
4. **Why** were the changes made?
5. **Where** was the last checkpoint?
.. note::
Every time an author makes a set of changes that are meaningful together, she commits her changes by describing them, creating a checkpoint in the timeline to return to in the future.
The changes possible in a commit are:
- editing a file
- adding a file
- removing a file
- renaming (moving) a file
Commits do not know about the timeline they are in. They only know of their preceeding commit, otherwise known as their **parent**.
You can always **checkout** a commit: visit the repository at that checkpoint on its timeline. Basically time-travel.
.. image:: assets/images/commits.png
:width: 500px
:scale: 100 %
----
Core concept: Working Areas
===========================
1. **Working tree**: your files right now
2. **Staging area**: selection for the next commit
3. **Repository history**: overview of commits
.. container:: row
.. image:: assets/images/working-tree.png
:width: 400px
:scale: 100 %
.. image:: assets/images/staging.png
:width: 400px
:scale: 100 %
.. image:: assets/images/timeline.png
:width: 400px
:scale: 100 %
.. note::
This is why Git feels "archival":
- you intentionally select what becomes part of the record.
----
Typical solo local workflow
===========================
1. **You initalise a directory on your computer with git**.
2. **You make changes on the directory**.
3. **You stage your changes and commit them**.
4. Repeat steps **2** and **3**.
**Use case**: tracking changes on a local, private folder, like bookkeeping.
----
Typical solo remote workflow
============================
1. You clone a repository from a remote host to your local computer.
2. You make your changes to the repository.
3. You stage and commit your changes.
4. **You push (upload) your commit up to the remote**.
5. Repeat steps **2**, **3** and **4**
**Use case**: tracking and backing up a private folder, such as passwords.
----
Typical collaborative remote workflow
=====================================
1. You clone a repository from a remote host to your local computer.
2. You make your changes to the repository.
3. You stage and commit your changes.
4. You push (upload) your commit up to the remote.
5. **You pull (download) other people's commits from the remote**.
6. Repeat steps **5**, **2**, **3** and **4**
**Use case**: tracking and collaborating on a repository with others such as a website project with multiple developers.
----
Core concept: Branching
=======================
.. container:: row
.. container::
In git, a **branch** is a named series of commits.
.. note::
In the previous example, there is only one branch, named "main" by default.
When you want to "take a detour" from the main course of a repository, you can create a separate branch.
.. note::
Now, parrallel timelines of the same repository exist next to each other.
Example **use cases** of branching:
- Experiment with a new feature affecting many files
- Proposing an improvement to your collaborators
- Have multiple versions of a website online
- Making existing software compatible somewhere else
.. note::
There is a lot of discourse around when to branch and how often. It varies from person to person and group to group.
From the perspective of git, since branching doesn't add any technical overload on a project, it is encouraged to branch more and branch often. From a logical perspective, every branch creates a parrallel timeline, and this might be a lot to keep track of mentally.
Branching allows for and encourages collaboration and is at the core of the free and open source software movement.
.. image:: assets/images/branching.png
:width: 500px
:scale: 100 %
----
Core concept: Merging
=====================
.. container:: row
.. container::
In git, **merging** is when you consolidate commits from a separate branch into your own.
.. note::
There are various merging techniques, and most of the time, the automated algorithm will work.
Sometimes, you might encounter a **merge confilct**: a section of a file where both branches have conflicting changes that cannot be automatically resolved. Here, you have to manually resolve the conflicts.
.. note::
which can take the form of:
- accepting a change from one branch and rejecting the other
- accepting and keeping both changes
- re-editing the files to incorporate both changes
After merging two branches, a **merge commit** is created. This is an exceptional commit that has two parent commits instead of one.
.. image:: assets/images/merge.png
:width: 400px
:scale: 100 %
----
Complex collaborative remote workflow
=====================================
1. You clone a repository from a remote host to your local computer.
2. **You create a new branch "my-feature" for your changes**.
3. You make your changes to the repository.
4. You stage and commit your changes.
5. You push your commit (and new branch) up to the remote.
6. You pull other people's commits on this branch from the remote.
7. Repeat steps **6**, **3**, **4** and **5**
8. **You switch back to "main" and merge "my-feature" into it**.
9. **You push your new merge commit up to the "main" branch**.
**Use case**: you are designing a website for a client and want to show 3 different versions of it with different background colours.
**Use case**: tracking and collaborating on a repository with others such as a website project, where two online versions of the website exist, a "safe" one that is available to the public, and an "experimental" one that is reserved for trying new features together.
----
.. image:: assets/images/braids.png
:width: 100 %
:scale: 100 %
----
Recap
=====
- **repository**: a directory initialised with git
- **commit**: a checkpoint in the repository timeline(s)
- **checkout**: to visit the repository at a specific commit in its history.
- **working tree**: your files as they are right now in the repository
- **staging area**: a place to add changes to
- **remote**: a copy of the repository on a different host
- **clone**: to download an identical copy of a repository
- **push**: to upload local commits to a remote repository
- **pull**: to re-download commits from the remote repository
- **branch**: a named series of commits, a detour, a parallel timeline
- **merge**: a consolidation of commits from another branch
----
Install Git
===========
Check first:
.. code-block:: bash
git --version
If missing:
- macOS: `Xcode Command Line Tools <https://www.mikegopsill.com/posts/install-xcode-command-line-tools/>`_
- Windows: `Git for Windows <https://git-scm.com/install/windows>`_
- Linux: package manager (apt/dnf/pacman)
Minimum requirement: you can run `git` in a terminal.
----
Commands: the essentials
========================
- ``git init`` (initalise a repo)
- ``git status`` (what's happening?)
- ``git add`` (add changes to the commit)
- ``git rm`` (remove a tracked file)
- ``git commit`` (store changes in the repo)
- ``git log`` (see the timeline)
- ``git checkout`` (visit the timeline at a specific checkpoint)
- ``git clone`` (an existing repo)
- ``git push`` (your commits to a remote server)
- ``git pull`` (sync with a repo online and merge)
- ``git branch`` (take a detour)
- ``git merge`` (merge branches)
----
Command: git init
=================
Create a repository in the current folder.
Use this when you are creating and working on your own projects.
.. code-block:: bash
git init
Creates a `.git/` directory containing history + metadata.
.. note::
For the exercise we will use `git clone` instead of `git init`.
----
Command: git status (your dashboard)
====================================
.. code-block:: bash
git status
Shows:
- current branch
- staged vs unstaged changes
- untracked files
----
Command: git add (select files)
===============================
First, create a file
.. code-block:: bash
nano index.html
Stage files for the next commit.
.. code-block:: bash
git add index.html
Stage everything (use carefully):
.. code-block:: bash
git add .
.. note::
Staging is curatorial: select what belongs together.
----
Optional: git rm
================
Remove a tracked file and stage the removal:
.. code-block:: bash
git rm old.html
git commit -m "Remove old page"
For this workshop you probably will not need it.
----
Command: git commit (checkpoint)
================================
.. code-block:: bash
git commit -m "Added name to my page"
Good commit message pattern:
- What changed
- Why it changed (reason/intent)
- Scope stays small
.. note::
repeat edit > stage > commit a couple times?
..
----
Command: git diff (what changed)
================================
Unstaged changes:
.. code-block:: bash
git diff
Staged changes:
.. code-block:: bash
git diff --staged
----
Command: git log (timeline)
============================
.. code-block:: bash
git log --oneline --graph
Gives a quick "finding aid" of earlier commits. Press 'q' to exit.
----
Command: git checkout (timetravel)
==================================
.. code-block:: bash
git checkout your_commit_id
See your working tree as it would have been at a specific commit on the timeline.
----
Forgejo: what we use today
==========================
- Forgejo is an open-source alternative to Github
- Forgejo hosts the central repository (remote)
You will:
- create an account
- clone via HTTPS
- push your branch
Share your username with us so we can add you as a collaborator
Rules for today:
- do NOT push to `main`
- create your branch under `braids/<your-slug>`
----
Forgejo: account setup
======================
1. Create account at: `<git.hackersanddesigners.nl>`_
2. Confirm you can sign in
Resources:
- `<https://git.hackersanddesigners.nl/hrk/braids>`_ - the repo we will be working in
- live gallery URL: `<https://braids.hackersanddesigners.nl>`_
- these slides: `<https://braids.hackersanddesigners.nl/slides>`_
----
Exercise overview
=================
You will build a (deliberately) simple page:
- "Hi, I'm …"
- maybe a gif?
- a link?
- optional: background, glitter, bad taste encouraged
Workflow loop:
clone -> branch -> edit -> status -> add -> commit -> push -> view -> iterate
----
Command: git clone
==================
Clone (copy) a repository in the current folder. First, ``cd`` to a logical location in your computer, then:
.. code-block:: bash
git clone https://git.hackersanddesigners.nl/hrk/braids
That will checkout the repo into a directory ``/braids``, go into this new directory with:
.. code-block:: bash
cd braids
You have now downloaded a repo from the web, complete with the full commit history and all changes.
----
Command: git branch
===================
Choose a slug: lowercase, no spaces. This can be your name or an alias. Example: change ``braids/<your-slug>`` in the command below to ``braids/alex``. From here on out replace <your-slug> with your chosen name!
List branches:
.. code-block:: bash
git branch
Create a branch:
.. code-block:: bash
git branch braids/<your-slug>
Switch to branch:
.. code-block:: bash
git checkout braids/<your-slug>
Shortcut (create + switch):
.. code-block:: bash
git checkout -b braids/<your-slug>
If everything went well, check the repo with:
.. code-block:: bash
git status
git branch
.. note::
Branches are parallel dossiers: safe space for changes.
----
Edit the page
================================
Edit the root `index.html` (and optionally add `style.css`, `assets/`).
Make a visible change first:
- Change the name to your name (or your alias)
Then check changes:
.. code-block:: bash
git diff
git status
----
Stage & commit your changes
=================================
.. code-block:: bash
git add index.html
git commit -m "Customize profile page for <your-slug>"
If you added assets:
.. code-block:: bash
git add assets/
git commit -m "Add assets for <your-slug>"
.. note::
Small commits win. One change = one deposit.
----
Push your banch
=================
Push your commits to the server, defining a remote branch to track. This is called setting the upstream.
.. code-block:: bash
git push -u origin braids/<your-slug>
(Again, change <your-slug>!)
This pushes your branch to the 'origin' server.
The first time you push to https://git.hackersanddesigners.nl the server will ask you for credentials. These will be remembered, so only once.
From then on, unless the remote/branch is named, ``git push`` will go in that direction.
.. code-block:: bash
git push
.. note::
disabled push rights for now, only for demonstration purposes, will fail
----
View live!
============================
Open the gallery:
- `<https://braids.hackersanddesigners.nl/>`_
Find your card:
- `braids/<your-slug>/`
Iterate:
edit -> status -> add -> commit -> push -> refresh
----
Common problems (fast fixes)
============================
Wrong branch:
.. code-block:: bash
git branch
git checkout braids/<your-slug>
Nothing staged:
.. code-block:: bash
git status
git add index.html
Push rejected (main protected):
- You are on `main`. Switch to your branch.
Auth issues:
- HTTPS: check username/password
----
Suggested “good enough” commit messages
=======================================
Bad:
- "update"
- "stuff"
- "changes"
Better:
- "Add animated gif and profile link"
- "Change background and typography"
- "Fix broken image path"
Rule: message should still make sense in 6 months.
----
Optional: git pull
====================
If you want to collaborate with others on the same branch, pull updates from server:
.. code-block:: bash
git pull
.. note::
During the exercise you mostly push your branch.
Pull is mainly for getting new changes on main (if needed).
fact: git pull is actually a git fetch && git merge
----
Optional: git merge
===================
First, go ahead and ``git fetch --all`` branches from the remote git repository, so you have them locally.
Then ``git branch`` to see the available branches.
Check some of them out with ``git checkout braids/<branch_name>``.
See something you like? Merge with them.
.. code-block:: bash
git checkout braids/<your-slug>
git merge braids/<chosen_branch>
Consolidate any merge conflicts manually if you have to. Then, stage, commit and push your changes to your branch.
----
Optional extension (if time remains)
====================================
- Compare two branches visually (gallery view)
- Show `git log` to narrate your work as a documented process
----
Wrap-up
=======
Learn more:
- `Learn Git Branching <https://learngitbranching.js.org/>`_
- `Oh My Git <https://ohmygit.org/>`_
.. note::
End: remind participants their branches will be removed after the workshop.
Reference in a new issue View git blame Copy permalink