/
README.Rmd
64 lines (47 loc) · 3.67 KB
/
README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# gitcellar
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/ropensci-org/gitcellar/actions)
[](https://github.com/ropensci-org/gitcellar/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The goal of gitcellar is to help you download [archives](https://docs.github.com/en/repositories/archiving-a-github-repository/backing-up-a-repository) of all repositories in an organization.
For context see the blog post [Safeguards and Backups for GitHub Organizations](https://ropensci.org/blog/2022/03/22/safeguards-and-backups-for-github-organizations/).
## Installation & setup
You can install the development version of gitcellar from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("ropensci-org/gitcellar")
```
You will need a GitHub Personal Access Token (PAT).
See [gh docs on the topic](https://gh.r-lib.org/articles/managing-personal-access-tokens.html).
You need to be an owner of the organisation you're trying to back up.
[Scopes needed](https://docs.github.com/en/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom): `repo` and `admin:org`.
## Example
This is a basic example which shows you how to download archives of all repositories in an organization (of which you are an owner):
```{r example, eval=FALSE}
library(gitcellar)
download_organization_repos(organizations = "maelle-test")
```
The archives (`<org-name>_<repo-name>_migration_archive.tar.gz`) will be saved in distinct folders (`archive-<org-name>_<repo-name>`) under the current directory (or the directory you input via the argument `dest_folder`).
It might seem wasteful to create one archive per repository as opposed to one archive of all repositories but in our experience it prevents failures.
Then, the reason to store one archive per _folder_ is due to the fact that it worked better with the tool we used for uploading the archive to a cloud service.
After this step, you can use the tool of your choice to upload the backups to a cloud service like Digital Ocean, AWS, etc.
You could run the code once a week and keep 8 weeks of backups on a rolling basis.
### Where is the code?
In the archive .tar.gz, you will find JSON files of metadata about the organizations (members for instance) and repositories (issues, pull requests) but also *bare git repositories*.
A [bare git repository](https://www.theserverside.com/blog/Coffee-Talk-Java-News-Stories-and-Opinions/What-is-a-bare-git-repository) is a git repository as it exists on a remote.
All the code is in there but you cannot see it **until you clone the bare git repository to another folder** where you will be able to see the files because by default the clone is not bare.
Or you can use [`gert::git_ls(<path-to-bare-repo>, ref = "<default-branch>")`](https://docs.ropensci.org/gert/reference/git_commit.html) to list files tracked in the bare git repository.
You could think of the bare git repositories as a compressed version of the code in the sense that it contains all the information, and that you just need a few steps (cloning to another folder) to get to the actual repository content (including all its git history).