primer-spec icon indicating copy to clipboard operation
primer-spec copied to clipboard

Code block observes GitHub repo

Open sugihjamin opened this issue 2 years ago • 4 comments

Is your feature request related to a problem? Please describe. Spec and code get out of synch.

Describe the solution you'd like When code on main branch of a GitHub repo is updated, corresponding code in spec automatically updates. This would mean beyond simply linking to GitHub code as is done in Trello card, but to track commit/push history to link to the correct code as it moves around after updates.

Describe alternatives you've considered Manual updates.

Additional context I think one of the faculty candidate from UCBerkeley had a similar feature built into the equivalent of an IDE.

sugihjamin avatar Apr 12 '22 15:04 sugihjamin

If the repo hosting the code is public, this might actually be possible! I’ll explore this further.

Thanks for all the feature requests and feedback btw :)

seshrs avatar Apr 12 '22 16:04 seshrs

Though I'm not sure how we would be able to track code if line numbers / file names move around.

Do you have a link / video to an example demonstration of the feature in some other context?

seshrs avatar Apr 12 '22 16:04 seshrs

I was referring to Andrew Head et al.'s paper, "Composing Flexibly-Organized Step-by-Step Tutorials from Linked Source Code, Snippets, and Outputs," SIGCHI 2020, http://dx.doi.org/10.1145/3313831.3376798. tutorial-authoring.pdf

sugihjamin avatar Apr 12 '22 16:04 sugihjamin

Though I'm not sure how we would be able to track code if line numbers / file names move around.

Do you have a link / video to an example demonstration of the feature in some other context?

Is it possible to inspect GitHub's commit and push and merge history programmatically?

sugihjamin avatar Apr 12 '22 16:04 sugihjamin