badjware
/
gitforgefs
mirror of https://github.com/badjware/gitlabfs.git
1
0
Fork 0
Code Releases Activity

Compare commits

base: badjware:d0bc974df1932e8df34d9d72dde64f4dcc13278b
Branches Tags
badjware:master
badjware:dev
badjware:v1.0.0
badjware:alpha2
badjware:alpha1
...
compare: badjware:026089d786dff18e66cd4304c7116e05689d6094
Branches Tags
badjware:master
badjware:dev
badjware:v1.0.0
badjware:alpha2
badjware:alpha1

2 Commits
d0bc974df1 ... 026089d786

Author SHA1 Message Date
Massaki Archambault 026089d786 remove completed improvements from readme 2022-11-25 12:26:26 -05:00
Massaki Archambault 9de94ea8fe update install instructions 2022-11-25 12:25:47 -05:00
1 changed files with 1 additions and 3 deletions
Show Stats Expand all files Collapse all files

4
README.md
View File

@ -55,7 +55,7 @@ $ tree -L 4
Install [go](https://golang.org/) and run Install [go](https://golang.org/) and run
``` sh ``` sh
go get github.com/badjware/gitlabfs go install github.com/badjware/gitlabfs@latest
``` ```
The executable will be in `$GOPATH/bin/gitlabfs` or `~/go/bin/gitlabfs` by default. For convenience, copy `gitlabfs` somewhere suitable or add `~/go/bin` in your `PATH`. The executable will be in `$GOPATH/bin/gitlabfs` or `~/go/bin/gitlabfs` by default. For convenience, copy `gitlabfs` somewhere suitable or add `~/go/bin` in your `PATH`.
@ -109,8 +109,6 @@ To reduce the number of calls to the Gitlab api and improve the responsiveness o
While the filesystem lives in memory, the git repositories that are cloned are saved on disk. By default, they are saved in `$XDG_DATA_HOME/gitlabfs` or `$HOME/.local/share/gitlabfs`, if `$XDG_DATA_HOME` is unset. `gitlabfs` symlink to the local clone of that repo. The local clone is unaffected by project rename or archive/unarchive in Gitlab and a given project will always point to the correct local folder. While the filesystem lives in memory, the git repositories that are cloned are saved on disk. By default, they are saved in `$XDG_DATA_HOME/gitlabfs` or `$HOME/.local/share/gitlabfs`, if `$XDG_DATA_HOME` is unset. `gitlabfs` symlink to the local clone of that repo. The local clone is unaffected by project rename or archive/unarchive in Gitlab and a given project will always point to the correct local folder.
## Known issues / Future improvements ## Known issues / Future improvements
* ~~There is a race condition that could happen when interacting with git that needs to be fixed.~~
* ~~Cloning and pulling repositories is currently very resource-intensive, especially on large set of repositories. Need to track down what causes this to happen. For now, leaving `on_clone` set to `init` and `auto_pull` to `false` in the configuration avoids the issue.~~
* Cache persists forever until a manual refresh is requested. Some way to automatically refresh would be nice. * Cache persists forever until a manual refresh is requested. Some way to automatically refresh would be nice.
* The filesystem is currently read-only. Implementing `mkdir` to create groups, `ln` or `touch` to create projects, etc. would be nice. * The filesystem is currently read-only. Implementing `mkdir` to create groups, `ln` or `touch` to create projects, etc. would be nice.
* Code need some cleanup and could maybe be optimized here and there. * Code need some cleanup and could maybe be optimized here and there.