lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated the proposal doc

Browse Source
This commit is contained in:
pratap043 2022-07-22 08:23:41 +05:30 committed by GitHub
parent aa4d936dc1
commit 137c2a4075
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/proposals/locking_notes.md
View File

@ -9,55 +9,7 @@ The git-lfs REST API for Locks creation should be able to accept additonal attri
## API extensions
The current Git LFS File Locking API [https://github.com/git-lfs/git-lfs/blob/v3.2.0/docs/api/locking.md] doesn't have a field to capture some information related to Locks creation which would be useful to understand why and from where the lock was acquired. To get more understanding, below is the use case:
Consider an application where source control management is one of the feature and GitHub is the repository being used. Here there are 3 workspaces with 2 users working on a single Repository containing 6 files.
Here the User1 is working on FileA, FileB under Workspace W1, User2 is working on FileC, FileD under Workspace W2 and also User1 is working on FileE, FileF under Workspace W3.
So we acquire locks before working on these files respectively. Now we can see that W1 has locks on FileA, FileB. W2 has locks on FileC, FileD. W3 has locks on FileE, FileF.
Repository
Wl
-- User1
------ FileA
------ FileB
W2
-- User2
------ FileC
------ FileD
W3
-- User1
------ FileE
------ FileF
Now when we run List Locks request from W1, we will get all locks on the Repo as given below. Here we doesn't know from which workspaces, the locks were acquired.
User Workspace File
User1 -- FileA
User1 -- FileB
User1 -- FileE
User1 -- FileF
User2 -- FileC
User2 -- FileD
Our requirement is to get the workspace information along with locks, to know from where the locks were acquired as given below (say When fetchLocks is run from W1):
User Workspace File
User1 W1 FileA
User1 W1 FileB
User1 W3 FileE
User1 W3 FileF
User2 W2 FileC
User2 W2 FileD
So if we capture this workspace info (as per above use case) as part of custom attribute during lock creation, same can be retrieved back and displayed.
Sample pre-defined comment during acquiring lock is as given below:
<SCMComment xmlns='http://schemas.cordys.com/cws/1.0'> <Comment>Automatically locked by the web interface upon editing</Comment><UserDN>sysadmin</UserDN><Workspace>'Workspace A' from organization 'system'</Workspace><DateTime>1656321671318</DateTime></SCMComment>
Here UserDN element has the Logged in username of the Application. The owner attribute from the List Locks response would give us the Git Repo user. The Workspace element would give us the workspace information.
The current Git LFS File Locking API [https://github.com/git-lfs/git-lfs/blob/v3.2.0/docs/api/locking.md] doesn't have a field to capture some information related to Locks creation which would be useful to understand why and from where the lock was acquired.
With this enhancement, we can have some predefined comment as part of lock creation and get back same with the List Locks REST API so that it will be useful to differentiate and get more information on the File lock.