Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to create GIN private repo for crab data #81

Merged
merged 23 commits into from
Dec 1, 2023
Merged

Conversation

sfmig
Copy link
Collaborator

@sfmig sfmig commented Nov 16, 2023

A guide on how to set up a GIN private repo for the crab data.

To be shared with NIU team when we finalise it.

I added my current thoughts about how it works. Any feedback on making things clearer / less verbose is more than welcome!

@sfmig sfmig force-pushed the smg/GIN-repository-guide branch from 6a5a1c2 to 3c50b28 Compare November 21, 2023 11:58
@codecov-commenter
Copy link

codecov-commenter commented Nov 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (224b2bd) 29.81% compared to head (da5efea) 23.91%.
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #81      +/-   ##
==========================================
- Coverage   29.81%   23.91%   -5.91%     
==========================================
  Files           6        8       +2     
  Lines         332      414      +82     
==========================================
  Hits           99       99              
- Misses        233      315      +82     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sfmig sfmig linked an issue Nov 22, 2023 that may be closed by this pull request
@sfmig sfmig marked this pull request as ready for review November 29, 2023 16:21
@sfmig sfmig requested a review from samcunliffe November 29, 2023 16:22
Copy link
Member

@samcunliffe samcunliffe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, OK let's leave this in here for now.
@adamltyson this was the blog candidate we were chatting about this morning.

guides/CreateGINPrivateRepo.md Outdated Show resolved Hide resolved
guides/CreateGINPrivateRepo.md Outdated Show resolved Hide resolved
guides/CreateGINPrivateRepo.md Outdated Show resolved Hide resolved
guides/CreateGINPrivateRepo.md Show resolved Hide resolved
guides/CreateGINPrivateRepo.md Show resolved Hide resolved
guides/CreateGINPrivateRepo.md Outdated Show resolved Hide resolved
guides/CreateGINPrivateRepo.md Outdated Show resolved Hide resolved

- Pending questions
- What is the best approach re this "data duplication"
- Where is the content of the files stored? Is it in the GIN server?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The answer is yes (as of your experiments today), right?
And then this PR could "close" #79.


- Unlocked files can be edited. If the data is unlocked and the full content of the dataset is downloaded locally, the file in the working directory has content, and so does its copy under git annex. This doubles disk usage of files checked into the repo, but in exchange users can modify and revert files to previous commits.

- Locked files cannot be edited. In MacOS, we may be prompted to unlock the files if we try to edit them, but we won't be able to save any changes because we don't have writing permissions. Files need to be committed before locking (double check).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand.

On MacOS who prompts you to unlock when you try to edit? Is it a GIN tool?

guides/CreateGINPrivateRepo.md Outdated Show resolved Hide resolved
@sfmig sfmig merged commit 0197167 into main Dec 1, 2023
6 checks passed
@samcunliffe samcunliffe deleted the smg/GIN-repository-guide branch December 1, 2023 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GIN repository for dataset 1
3 participants