JuliaDynamics/DrWatson.jl

Recreate repo state based on tagged file

Open

#357 opened on Sep 25, 2022

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Julia (915 stars) (94 forks)batch import
enhancementgithelp wanted

Description

Thank's for a nice package!

I could not find this, but perhaps this functionality already exists?

Basically, I think a nice functionality would be something like

function recreate_repo_state(file)
 d = load(file) 
 istagged(d) || throw(...)
 if ispatch(d)
  checkout_patch(d["commit"], d["patch"])
 else
  isdirty(d["commit"]) && @warn ...
  checkout(d["commit"])
 end

to allow easy reproducing of old results. The checkout function should be easy, but I'm not sure how to do the checkout_patch...

Additional related feature suggestions

  • If packages with separate git-repos exists in src, also check these out to the tagged state
  • Provide an easy mechanism such as reset_repo_state to go back to the current state (including repos in src)

Contributor guide

Tech stack
None
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic Juliafamiliarity with DrWatson.jlunderstanding of git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Explore existing functions such as `load`, `istagged`, and `checkout` in the DrWatson.jl codebase, particularly in src/save.jl or similar files. Check linked issues or comments for any prior discussion on reproducing repo state. Consider how `checkout patch` might be implemented using LibGit2 or similar tools.
Recreate repo state based on tagged file · JuliaDynamics/DrWatson.jl#357 | Good First Issue