diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml index 65f0e7c..445af85 100644 --- a/docs/articles/toc.yml +++ b/docs/articles/toc.yml @@ -2,5 +2,5 @@ items: - name: Quickstart href: intro.md - - name: How to use - href: manual.md \ No newline at end of file + - name: Version Control + href: version-control.md \ No newline at end of file diff --git a/docs/articles/version-control.md b/docs/articles/version-control.md new file mode 100644 index 0000000..f785e48 --- /dev/null +++ b/docs/articles/version-control.md @@ -0,0 +1,10 @@ +Version Control +========== + +A repository is represented in Bonsai by the [`CreateRepository`](xref:AllenNeuralDynamics.VersionControl.CreateRepository) operator. Several properties are exposed via this object, including the name and hash of the current commit. + +In order to make it easier for users to evaluate the state of the local repository, an additional operator, [`IsRepositoryClean`](xref:AllenNeuralDynamics.VersionControl.IsRepositoryClean), is provided to check if the repository is in a clean state (i.e. are there any untracked or uncommitted changes). + +:::workflow +![PredictPoseIdentities](~/workflows/CheckRepositoryStatus.bonsai) +::: \ No newline at end of file diff --git a/docs/workflows/CheckRepositoryStatus.bonsai b/docs/workflows/CheckRepositoryStatus.bonsai new file mode 100644 index 0000000..23e48cd --- /dev/null +++ b/docs/workflows/CheckRepositoryStatus.bonsai @@ -0,0 +1,38 @@ + + + + + + + ../. + + + + + false + + + + + + + Source1 + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/workflows/CheckRepositoryStatus.svg b/docs/workflows/CheckRepositoryStatus.svg new file mode 100644 index 0000000..a6b985c --- /dev/null +++ b/docs/workflows/CheckRepositoryStatus.svg @@ -0,0 +1,3 @@ + +]>ConditionIsRepositoryCleanCreateRepository \ No newline at end of file