Git Workflows with RStudio

name: title
class: inverse, center, middle
# .orange[Git Workflows with RStudio]
<img src="slides_files/GitHub-Mark.png" height="120px"/>
<img src="slides_files/rstudio_hex.png" height="125px"/>
### .rstudio-blue[KATIE MASIELLO]
.large[RStudio Customer Success]

---

# Scope for Today

.left-column[
![](slides_files/20_min.png)

]
.right-column[
* Essential Git / Github concept and vocabulary

* Basic Git workflows in RStudio IDE

* Automated Deployment with RStudio Connect <br>(*aka how you look like a superhero*) <br> ![hero](slides_files/hero.gif)
]
---
class: center, middle

# Why do we use git? 
###.rstudio-blue[(or why should we?)]

???
Commonly:  
* out of control file naming  
* it gets complicated beyond track changes in one file  
* because we've been told its good for us
---
class: inverse 
#How's git going?
.left-even-column[<img src="https://imgs.xkcd.com/comics/git.png"> .small[source: [xkcd](https://imgs.xkcd.com/comics/git.png)]]

.right-even-column[<img src="slides_files/greg_tweet.png" width = 100%>]

---
# EIKIFJB <span style = 'font-size: 80%;'>(*everything I know is from Jenny Bryan*)</span>

.left-column[
<br>
![](slides_files/eikifjb.png)
]
.right-column[
![https://happygitwithr.com/](slides_files/happygitwithr.png)]

**Start here** -> https://happygitwithr.com/

---
# Vocabulary

<div id="sbyjhtmciw" style="overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
<style>html {
  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Helvetica Neue', 'Fira Sans', 'Droid Sans', Arial, sans-serif;
}

#sbyjhtmciw .gt_table {
  display: table;
  border-collapse: collapse;
  margin-left: auto;
  margin-right: auto;
  color: #333333;
  font-size: 16px;
  font-weight: normal;
  font-style: normal;
  background-color: #FFFFFF;
  width: auto;
  border-top-style: solid;
  border-top-width: 2px;
  border-top-color: #A8A8A8;
  border-right-style: none;
  border-right-width: 2px;
  border-right-color: #D3D3D3;
  border-bottom-style: solid;
  border-bottom-width: 2px;
  border-bottom-color: #A8A8A8;
  border-left-style: none;
  border-left-width: 2px;
  border-left-color: #D3D3D3;
}

#sbyjhtmciw .gt_heading {
  background-color: #FFFFFF;
  text-align: center;
  border-bottom-color: #FFFFFF;
  border-left-style: none;
  border-left-width: 1px;
  border-left-color: #D3D3D3;
  border-right-style: none;
  border-right-width: 1px;
  border-right-color: #D3D3D3;
}

#sbyjhtmciw .gt_title {
  color: #333333;
  font-size: 125%;
  font-weight: initial;
  padding-top: 4px;
  padding-bottom: 4px;
  border-bottom-color: #FFFFFF;
  border-bottom-width: 0;
}

#sbyjhtmciw .gt_subtitle {
  color: #333333;
  font-size: 85%;
  font-weight: initial;
  padding-top: 0;
  padding-bottom: 6px;
  border-top-color: #FFFFFF;
  border-top-width: 0;
}

#sbyjhtmciw .gt_bottom_border {
  border-bottom-style: solid;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
}

#sbyjhtmciw .gt_col_headings {
  border-top-style: solid;
  border-top-width: 2px;
  border-top-color: #D3D3D3;
  border-bottom-style: solid;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
  border-left-style: none;
  border-left-width: 1px;
  border-left-color: #D3D3D3;
  border-right-style: none;
  border-right-width: 1px;
  border-right-color: #D3D3D3;
}

#sbyjhtmciw .gt_col_heading {
  color: #333333;
  background-color: #FFFFFF;
  font-size: 100%;
  font-weight: normal;
  text-transform: inherit;
  border-left-style: none;
  border-left-width: 1px;
  border-left-color: #D3D3D3;
  border-right-style: none;
  border-right-width: 1px;
  border-right-color: #D3D3D3;
  vertical-align: bottom;
  padding-top: 5px;
  padding-bottom: 6px;
  padding-left: 5px;
  padding-right: 5px;
  overflow-x: hidden;
}

#sbyjhtmciw .gt_column_spanner_outer {
  color: #333333;
  background-color: #FFFFFF;
  font-size: 100%;
  font-weight: normal;
  text-transform: inherit;
  padding-top: 0;
  padding-bottom: 0;
  padding-left: 4px;
  padding-right: 4px;
}

#sbyjhtmciw .gt_column_spanner_outer:first-child {
  padding-left: 0;
}

#sbyjhtmciw .gt_column_spanner_outer:last-child {
  padding-right: 0;
}

#sbyjhtmciw .gt_column_spanner {
  border-bottom-style: solid;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
  vertical-align: bottom;
  padding-top: 5px;
  padding-bottom: 5px;
  overflow-x: hidden;
  display: inline-block;
  width: 100%;
}

#sbyjhtmciw .gt_group_heading {
  padding: 8px;
  color: #333333;
  background-color: #FFFFFF;
  font-size: 100%;
  font-weight: initial;
  text-transform: inherit;
  border-top-style: solid;
  border-top-width: 2px;
  border-top-color: #D3D3D3;
  border-bottom-style: solid;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
  border-left-style: none;
  border-left-width: 1px;
  border-left-color: #D3D3D3;
  border-right-style: none;
  border-right-width: 1px;
  border-right-color: #D3D3D3;
  vertical-align: middle;
}

#sbyjhtmciw .gt_empty_group_heading {
  padding: 0.5px;
  color: #333333;
  background-color: #FFFFFF;
  font-size: 100%;
  font-weight: initial;
  border-top-style: solid;
  border-top-width: 2px;
  border-top-color: #D3D3D3;
  border-bottom-style: solid;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
  vertical-align: middle;
}

#sbyjhtmciw .gt_from_md > :first-child {
  margin-top: 0;
}

#sbyjhtmciw .gt_from_md > :last-child {
  margin-bottom: 0;
}

#sbyjhtmciw .gt_row {
  padding-top: 8px;
  padding-bottom: 8px;
  padding-left: 5px;
  padding-right: 5px;
  margin: 10px;
  border-top-style: solid;
  border-top-width: 1px;
  border-top-color: #D3D3D3;
  border-left-style: none;
  border-left-width: 1px;
  border-left-color: #D3D3D3;
  border-right-style: none;
  border-right-width: 1px;
  border-right-color: #D3D3D3;
  vertical-align: middle;
  overflow-x: hidden;
}

#sbyjhtmciw .gt_stub {
  color: #333333;
  background-color: #FFFFFF;
  font-size: 100%;
  font-weight: initial;
  text-transform: inherit;
  border-right-style: solid;
  border-right-width: 2px;
  border-right-color: #D3D3D3;
  padding-left: 12px;
}

#sbyjhtmciw .gt_summary_row {
  color: #333333;
  background-color: #FFFFFF;
  text-transform: inherit;
  padding-top: 8px;
  padding-bottom: 8px;
  padding-left: 5px;
  padding-right: 5px;
}

#sbyjhtmciw .gt_first_summary_row {
  padding-top: 8px;
  padding-bottom: 8px;
  padding-left: 5px;
  padding-right: 5px;
  border-top-style: solid;
  border-top-width: 2px;
  border-top-color: #D3D3D3;
}

#sbyjhtmciw .gt_grand_summary_row {
  color: #333333;
  background-color: #FFFFFF;
  text-transform: inherit;
  padding-top: 8px;
  padding-bottom: 8px;
  padding-left: 5px;
  padding-right: 5px;
}

#sbyjhtmciw .gt_first_grand_summary_row {
  padding-top: 8px;
  padding-bottom: 8px;
  padding-left: 5px;
  padding-right: 5px;
  border-top-style: double;
  border-top-width: 6px;
  border-top-color: #D3D3D3;
}

#sbyjhtmciw .gt_striped {
  background-color: rgba(128, 128, 128, 0.05);
}

#sbyjhtmciw .gt_table_body {
  border-top-style: solid;
  border-top-width: 2px;
  border-top-color: #D3D3D3;
  border-bottom-style: solid;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
}

#sbyjhtmciw .gt_footnotes {
  color: #333333;
  background-color: #FFFFFF;
  border-bottom-style: none;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
  border-left-style: none;
  border-left-width: 2px;
  border-left-color: #D3D3D3;
  border-right-style: none;
  border-right-width: 2px;
  border-right-color: #D3D3D3;
}

#sbyjhtmciw .gt_footnote {
  margin: 0px;
  font-size: 90%;
  padding: 4px;
}

#sbyjhtmciw .gt_sourcenotes {
  color: #333333;
  background-color: #FFFFFF;
  border-bottom-style: none;
  border-bottom-width: 2px;
  border-bottom-color: #D3D3D3;
  border-left-style: none;
  border-left-width: 2px;
  border-left-color: #D3D3D3;
  border-right-style: none;
  border-right-width: 2px;
  border-right-color: #D3D3D3;
}

#sbyjhtmciw .gt_sourcenote {
  font-size: 90%;
  padding: 4px;
}

#sbyjhtmciw .gt_left {
  text-align: left;
}

#sbyjhtmciw .gt_center {
  text-align: center;
}

#sbyjhtmciw .gt_right {
  text-align: right;
  font-variant-numeric: tabular-nums;
}

#sbyjhtmciw .gt_font_normal {
  font-weight: normal;
}

#sbyjhtmciw .gt_font_bold {
  font-weight: bold;
}

#sbyjhtmciw .gt_font_italic {
  font-style: italic;
}

#sbyjhtmciw .gt_super {
  font-size: 65%;
}

#sbyjhtmciw .gt_footnote_marks {
  font-style: italic;
  font-weight: normal;
  font-size: 65%;
}
</style>
<table class="gt_table">
  
  
  <tbody class="gt_table_body">
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Git</td>
<td class="gt_row gt_left" style="font-size: medium;">A version control system that lets you manage history and changes</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">GitHub</td>
<td class="gt_row gt_left" style="font-size: medium;">Online hosted version of your Git history so you and others can access it from any computer</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Working Directory</td>
<td class="gt_row gt_left" style="font-size: medium;">Where the file(s) you are working on are stored</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Local</td>
<td class="gt_row gt_left" style="font-size: medium;">Your Computer</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Remote</td>
<td class="gt_row gt_left" style="font-size: medium;">An online version of your project</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Stage</td>
<td class="gt_row gt_left" style="font-size: medium;">Preparing files for commit; this allows you to break up your changes into smaller, logical pieces for each commit</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Commit</td>
<td class="gt_row gt_left" style="font-size: medium;">An annotated snapshot of your code; should be a (small) unit of work</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Master or Main</td>
<td class="gt_row gt_left" style="font-size: medium;">The main stream or branch of all development work</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Branch</td>
<td class="gt_row gt_left" style="font-size: medium;">A version/diversion of the master where you can add features, edit, etc. safely without affecting the Master</td></tr>
    <tr><td class="gt_row gt_left" style="color: #4D8DC9; font-size: medium; font-weight: bold;">Pull Request</td>
<td class="gt_row gt_left" style="font-size: medium;">The action of requesting changes in a branch be reviewed for incorporation (merging) into the Master</td></tr>
  </tbody>
  
  
</table>
</div>

???
Overall we need to consider three places:
* Your working directory 
* The local repository
* The remote repository

This vocabulary describes these places and how we move from one place to the other.

It's common to confuse your local working directory with your local repo because they live in more or less the same place.  In your Finder/Explorer window, you can see the evidence of your local repo if you show hidden files (Cmd + Shift + .  on Mac) and you'll reveal the .git folder and .gitignore file that overlay your working directory
---
## Basic Workflows
<img src="slides_files/workflow_v2.png" width = 100%>
<br><br>
💡 
*.rstudio-blue[**Working Directory**] is to .rstudio-blue[**File > Save**] as .rstudio-blue[**Staging Area**] is to .rstudio-blue[**Commit**]*

???
The mechanics of making a change, saving, staging, committing, and then pushing seems like a lot of steps to get something to GitHub but each of these actions is important.  
The process of working on a file, deciding you like it and saving it in your working directory is somewhat analogous to the act of staging files and then committing them to your local repo.  
As a best practice, think of commits as small bundles of work that you put into a box and seal up. These re the incremental changes or snapshots to your work.  
Think of staging as putting the files you've modified into the box before you seal it up with tape (or commit it). Put the things that go together in the box; for clarity later, avoid throwing all your work into one big box. 
Committing doesn't move our files or version history to GitHub.  That comes with a Push. 
Once we have established a remote repository, it can be accessed by collaborators, or even yourself from another computer.  
We get access to these remote files with various syncing processes as either a fetch or pull.
And when we checkout a branch, it brings those files to our local working directory so we can work with them.
---
## Working with Branches
<img src="slides_files/branches_v2.png" width = 100%>
<br><br>
💡 Every commit points back to the preceding commit(s)

💡 Commits contains file system snapshots and metadata (i.e., author of the change, commit message, parent(s))

*Excellent reference: https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell*

???
Branches let us and others work on the project without disturbing the main or master stream. When we are ready, we can merge our changes back in with a Pull Request.

---
# Helpful Reading

Git implementation with RStudio

* Happy git with R: https://happygitwithr.com/  
* This section of R Packages, by Wickham: http://r-pkgs.had.co.nz/git.html (Includes screen shots of git with the IDE)

Git in general
* Version Control, from The Missing Semester of Your CS Education: https://missing.csail.mit.edu/2020/version-control/
* Pro Git book (online): https://git-scm.com/book/en/v2
* Git cheat sheet: https://education.github.com/git-cheat-sheet-education.pdf

---
# Git-Backed Deployment Resources
<center>
<img src="slides_files/devtestprod.png", height="300px">
</center>

.smaller[* User documentation: https://docs.rstudio.com/connect/user/git-backed/
* Admin documentation: https://docs.rstudio.com/connect/admin/content-management/git-backed/
* Using git-backed deployment for development and prod: https://solutions.rstudio.com/misc/diffable-data-science-demo-with-bike-prediction/
* Publishing to RStudio Connect with Github Actions: https://solutions.rstudio.com/data-science-admin/deploy/github-actions/]

---
name: demo
class: inverse, middle, left
<br>
<br>
# <span style='font-size: 200%;'>Demo Time!</span>
<br>
<br>
### with exercises left to reader: 
* Introduce yourself to Git, [Chapter 7 Happy Git with R](https://happygitwithr.com/hello-git.html)
* Cache credentials, [Chapter 10 Happy Git with R](https://happygitwithr.com/credential-caching.html)
* Review Chapters 4-14 (*they’re really not long*)