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

Code block observes GitHub repo #167

Open
sugihjamin opened this issue Apr 12, 2022 · 4 comments
Open

Code block observes GitHub repo #167

sugihjamin opened this issue Apr 12, 2022 · 4 comments
Labels
enhancement New feature or request

Comments

@sugihjamin
Copy link

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 sugihjamin added the enhancement New feature or request label Apr 12, 2022
@seshrs
Copy link
Member

seshrs commented Apr 12, 2022

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
Copy link
Member

seshrs commented Apr 12, 2022

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?

@sugihjamin
Copy link
Author

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
Copy link
Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants