feat: add project repository version control module#27
Open
grantf04 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@algora-pbc /claim #10
Closes #10
What this adds
Adds a self-contained
project-repository-version-control/module for scientific project repositories: structured components, hash manifests, commits, branches, forks, merge requests, reproducibility checks, citations, export metadata, JSON APIs, tests, and a reviewer dashboard.Requirement mapping
demoRepository.fileswith manuscript, data, code, notebooks, results, protocols, and metadata.src/repository-core.js.runReproducibilityCheckfor pipeline, raw data hash, expected outputs, metadata schema, and sandbox status.src/server.jsandbuildExportBundle.How to verify in under 5 minutes
Open
http://localhost:4129and verify the dashboard shows repository DOI, component manifest, merge request diff summaries, reproducibility checks, citation text, and export metadata.Optional API smoke checks:
curl -s http://localhost:4129/api/dashboard curl -s http://localhost:4129/api/repositories/repo-organoid-response/manifest curl -s "http://localhost:4129/api/repositories/repo-organoid-response/citation?style=BibTeX"Validation
Commands run:
npm test- 4 tests passingcurl -s http://localhost:4129/api/dashboard- returns repository title, passed reproducibility status, and export bundle filenamecurl -s "http://localhost:4129/api/repositories/repo-organoid-response/citation?style=BibTeX"- returns BibTeX dataset citationcurl -i -s http://localhost:4129/package.json- returns 404 without crashing the serverhttp://127.0.0.1:4129/: repository, version-control, reproducibility, and citation/export panels render with 0 console errorsffprobeverified the committed demo video is 1280x760 and 8 seconds longDemo
project-repository-version-control/docs/demo-script.mdScope
This PR is intentionally self-contained under
project-repository-version-control/and avoids unrelated root-level changes except adding the module link to the root README.