-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
555 lines (434 loc) · 15 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title> Versioning your code (and more)</title>
<meta charset="utf-8" />
<meta name="author" content=" Stéphane DRAY" />
<script src="libs/header-attrs-2.11/header-attrs.js"></script>
<link rel="stylesheet" href="css/xaringan-themer.css" type="text/css" />
<link rel="stylesheet" href="css/custom.css" type="text/css" />
</head>
<body>
<textarea id="source">
class: right, middle, title-slide
# <br />Versioning your code (and more)
## <i>An illustration with <svg aria-hidden="true" role="img" viewBox="0 0 512 512" style="height:1em;width:1em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:#E1DDC1;overflow:visible;position:relative;"><path d="M216.29 158.39H137C97 147.9 6.51 150.63 6.51 233.18c0 30.09 15 51.23 35 61-25.1 23-37 33.85-37 49.21 0 11 4.47 21.14 17.89 26.81C8.13 383.61 0 393.35 0 411.65c0 32.11 28.05 50.82 101.63 50.82 70.75 0 111.79-26.42 111.79-73.18 0-58.66-45.16-56.5-151.63-63l13.43-21.55c27.27 7.58 118.7 10 118.7-67.89 0-18.7-7.73-31.71-15-41.07l37.41-2.84zm-63.42 241.9c0 32.06-104.89 32.1-104.89 2.43 0-8.14 5.27-15 10.57-21.54 77.71 5.3 94.32 3.37 94.32 19.11zm-50.81-134.58c-52.8 0-50.46-71.16 1.2-71.16 49.54 0 50.82 71.16-1.2 71.16zm133.3 100.51v-32.1c26.75-3.66 27.24-2 27.24-11V203.61c0-8.5-2.05-7.38-27.24-16.26l4.47-32.92H324v168.71c0 6.51.4 7.32 6.51 8.14l20.73 2.84v32.1zm52.45-244.31c-23.17 0-36.59-13.43-36.59-36.61s13.42-35.77 36.59-35.77c23.58 0 37 12.62 37 35.77s-13.42 36.61-37 36.61zM512 350.46c-17.49 8.53-43.1 16.26-66.28 16.26-48.38 0-66.67-19.5-66.67-65.46V194.75c0-5.42 1.05-4.06-31.71-4.06V154.5c35.78-4.07 50-22 54.47-66.27h38.63c0 65.83-1.34 61.81 3.26 61.81H501v40.65h-60.56v97.15c0 6.92-4.92 51.41 60.57 26.84z"/></svg></i>
### <br /><br />Stéphane DRAY
### .inst[Novembre 2021]
---
class: inverse, center, middle
## Introduction
---
.center[]
---
## Science is a long and step-by-step procedure
.center[
.img-source-tiny[https://images.slideplayer.com/27/8939519/slides/slide_4.jpg]
]
---
## Remember the time
.pull-right[
.center[]
]
---
## Remember the time
.pull-left[
Track the changes in a project:
- Data gathering: **Lab notebook**
- Data analysis: **Versioning**
- Article writing: **Versioning**
]
.pull-right[
.center[]
]
---
## Remember the time
.pull-left[
Track the changes in a project:
- Data gathering: **Lab notebook**
- Data analysis: **Versioning**
- Article writing: **Versioning**
.center[
.img-source-tiny[https://miro.medium.com/max/472/1*B0Ykkbhw5bzhHkY79cYrWg.jpeg]]
]
.pull-right[
.center[]
]
---
## An example
.center[https://github.com/FRBCesab/datatoolbox/]
---
class: inverse, center, middle
## Introduction to git
---
## git
There are several tools for versioning. This course focuses on `git`.
`git` is a program that takes **snapshots** of a directory tree and helps navigating between those snapshots.
- archiving/documentation of development steps
- backtracking to previous versions
- handling of multiple versions
- collaborative development
- backup (using external servers)
Especially useful when developing software, writing papers. . .
---
## Some definitions
- **repository**: a directory including with a `.git` directory
- **commit**: a snapchot of the repository (a date, an author, a description, a parent)
- **working copy**: a version of the files of the repository on your computer
- **index**: a temporary space including the modficiations to be commited
<br>
All git commands follow the same pattern:
```bash
git SUBCMD ARGS ∗
```
---
## Alternative to command line
* R with package `usethis`
* GUI in RStudio
.center[]
---
class: inverse, center, middle
## Starting with git
---
## Create a repository
```bash
git init
```
<br>
**Demo**
- Create a directory
- Move to the directory
- Initialize the repostitory
---
## Checking the state of the repository
```bash
git status
```
<br>
**Demo**
- Check the status of your repository
---
## Put a file under version control
```bash
git add FILE
```
<br>
Files in the directory are ignored by git unless they are explicitly added to the repository
**Demo**
- Create a text file
- Check the status of your repository
- Add the file to your repository
- Check the status of your repository
---
## Take a snapshot
```bash
git commit -a -m MSG
```
<br>
A snapshot in git is called a commit. The -m option introduces a message describing the changes in the new snapshot.
**Demo**
- Take a snaphsot of your repository
- Check the status of your repository
---
## Print commit history
```bash
git log
```
<br>
**Demo**
- Display the history
---
## Print an old version of a file
```bash
git show COMMIT ID:PATH
```
<br>
You can retrieve commit id using git log. Only the 6-8 letters of the id are generally enough
**Demo**
- Display the content of your text file at the previous commit
---
## Summary
Here are the basic commands to archive your work in a git repo:
| I want to | I use |
|---------------------------------|
|Initialize a new (empty) git repo| git init|
|Put files under version control| git add file1 file2 ...|
|Take a snapshot| git commit -a -m "commit descr"|
|See commit history| git log |
|See previous version of a file| git show aazef345:src/foo.c|
---
class: inverse, center, middle
## The 3 areas of git
---
## Revisiting git
- ** Working directory ** : your files, this is the place where you edit contents
<br>
- ** Commit graph **: snapshot storage
<br>
- ** Index **: a place in-between to prepare commits. It contains a list of modifications selected for the next commit
---
## Moving between the three areas
.center[]
.img-source-tiny[https://git-scm.com/blog/2011/07/11/reset.html]
---
## Moving between the three areas
- `git add` put updates of the working directory in the index
- `git commit` builds a commit from the contents of the index (option -a selects all modifications and put them in the index before committing)
- `git diff` shows differences between working directory and the index. With --cached option, shows differences between index and last commit
- `git checkout` update the working directory with the content of the repo
- `git reset HEAD` remove the last changes from the index
---
class: inverse, center, middle
## Using a distant server
---
## Why using a distant server
- A backup of your repository
- Work with others
- Increase your visibility
- Increase interactions with users
- Easy distribution of devel versions
<br>
There are several source hosting services run by academic or private institutions.
---
## Cloning a repo
```bash
git clone URL
```
<br>
This command create an (independent) copy of an existing repo, with all
its history.
**Demo**
- Try to clone the repository of the course
- Display the history of the repository
---
## Interact with the distant repository
```bash
git pull
```
This command will fetch commits from the cloned repo and update the working directory to latest commit.
<br>
<br>
```bash
git push
```
This command will send commits to the cloned repo. It requires write access.
**Demo**
- Try to obtain the last version of the course (after I update it)
- Modify the course and send your commit
---
## Summary
Here are the basic commands to work with a distant repo:
| I want to | I use |
|---------------------------------|
|Clone a distant repo| git clone https://github.com/...|
|Update local repo| git pull |
|Send commits to distant repo| git push |
---
class: inverse, center, middle
## Starting a new project on GitHub
---
## Identification
It is possible to use GitHub with https protocol but you will be asked for your GitHub username and password for each action.
ssh provides another way to access to a Git repository. If you generate ssh public and private keys, you can use git without username/password.
```bash
cd ~/
ssh -keygen - t rsa
```
**Demo**
- Copy the public key on GitHub (Settings)
- Create a new project
- Clone the repo
- Do a few commits
- Push your commits
- Modify and have a look to README.md
- Create an issue
---
class: inverse, center, middle
## Dealing with branches
---
## Commit graph and branches
Sometimes, you want to do experimental developments that diverge from the main line of development. Branches allow to "play" without messing with that main line.
- The main feature of branches is to allow switching between different versions very easily
- A branch should correspond to a topic, e.g. a bug fix, new feature, etc.
- especially useful when unsure when/if some modifications will be included (that is, very often)
- it permits several concurrent development processes
---
## Understanding branches
- commits form a graph
- each commit is linked to its parent(s)
- a branch is a pointer to a commit
- after repo init, there is a single branch called
master
- at all time, one branch is selected as the
”current branch”
<br>
** Demo **
https://learngitbranching.js.org/?NODEMO
---
## Branches in practice
- After a commit, a new commit is created in the graph and the current branch is moved to the new commit
- A new branch can be created by
```bash
git branch BRANCH_NAME
```
The new branch is located at the same location than the current branch. Commits act on the current branch
- It is possible to switch to a branch by
```bash
git checkout BRANCH_NAME
```
Current branch (and the working directory) is updated to reflect the state of the corresponding commit
---
## Branches in practice
- A branch can be deleted by
```bash
git branch -d BRANCH_NAME
```
Only the pointer is deleted, not the pointed commits but commit may be hard to find after branch deletion.
- Two branches can be merged by
```bash
git merge BRANCH_NAME
```
git will try to merge the snapshot pointed by current branch and the one pointed by the branch given in argument.
It creates a new commit and moves the current branch to the newly created commit.
The newly created commit has two parents!
---
class: inverse, center, middle
## Work with others
---
## A distributed system
.center[]
.img-source-tiny[https://miro.medium.com/max/1698/1*GgaGcwh5L246YcU5NVDA5A.png]
---
## Dealing with conflicts
What happens if someone push before me? A conflict.
Two commits are in conflict when they contain different updates to the same area of a file. They should be resolved manually after merging
To avoid conflicts, update your branch before you start working on something and make frequent and small commits
---
## Demo
- Invite a colleague in your project
- Clone the repo
- Create commit, branches, etc.
- Push
- If they are conflicts, try to solve them
---
class: inverse, center, middle
## Git and RStudio
---
## GUIs for git
There are several GUIs for git. RStudio provides a convenient way to deal with R projects
** Demo **
- Create a project and configure RStudio
---
## Acknowledgments
This presentation is strongly inspired from the slides of Philippe Veber (LBBE)
<br>
A good summary:
.center[
https://github.github.com/training-kit/downloads/fr/github-git-cheat-sheet.pdf]
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
<script src="libs/macros.js"></script>
<script>var slideshow = remark.create({
"ratio": "4:3",
"highlightStyle": "zenburn",
"highlightLines": false,
"countIncrementalSlides": false,
"slideNumberFormat": "%current% / %total%"
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();</script>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];
if (code.parentNode.tagName !== 'PRE' && code.childElementCount === 0) {
text = code.textContent;
if (/^\\\((.|\s)+\\\)$/.test(text) || /^\\\[(.|\s)+\\\]$/.test(text) ||
/^\$\$(.|\s)+\$\$$/.test(text) ||
/^\\begin\{([^}]+)\}(.|\s)+\\end\{[^}]+\}$/.test(text)) {
code.outerHTML = code.innerHTML; // remove <code></code>
continue;
}
}
i++;
}
};
slideshow._releaseMath(document);
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-MML-AM_CHTML';
if (location.protocol !== 'file:' && /^https?:/.test(script.src))
script.src = script.src.replace(/^https?:/, '');
document.getElementsByTagName('head')[0].appendChild(script);
})();
</script>
</body>
</html>