https://github.com/clojure/tools.gitlibs
API for retrieving, caching, and programatically accessing git libraries
https://github.com/clojure/tools.gitlibs
Last synced: about 1 month ago
JSON representation
API for retrieving, caching, and programatically accessing git libraries
- Host: GitHub
- URL: https://github.com/clojure/tools.gitlibs
- Owner: clojure
- License: epl-1.0
- Created: 2018-01-02T16:31:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T17:41:14.000Z (7 months ago)
- Last Synced: 2025-04-08T11:15:06.733Z (2 months ago)
- Language: Clojure
- Homepage:
- Size: 187 KB
- Stars: 63
- Watchers: 8
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
tools.gitlibs
========================================
An API for retrieving, caching, and programatically accessing git libraries.
## Rationale
To access git dependencies (for example, via tools.deps), one must download git directories
and working trees as indicated by git shas. This library provides this functionality and also
keeps a cache of git dirs and working trees that can be reused.
## API
The following API is provided in `clojure.tools.gitlibs`:
* `(resolve git-url rev) ;; returns full sha of rev in git-url`
* `(procure git-url lib rev) ;; returns working tree directory for git-url identified as lib at rev`
* `(descendant git-url revs) ;; returns rev which is a descedant of all revs, or nil if none`
* `(tags git-url) ;; returns a collection of tags in this git-url (fetches to refresh)`
* `(cache-dir) ;; returns path to root of gitlibs cache dir`
### Git urls
The following git url types are supported:
* `https` - for public anonymous clone and fetch of public or private repos with credentials via git credential sources
* `ssh` - for authenticated clone and fetch of private repos (uses ssh)
* `http` and `git` protocols are plain-text and NOT supported or recommended
### Revs
The API functions all take revs, which can be any git rev that resolves to a commit, such as:
* Full sha (40 chars)
* Prefix sha (sufficiently unique in the repo, often 7 chars)
* Tag name
* Branch name
Procured working trees are always cached on the basis of the rev's full sha, so using `procure`
repeatedly on a rev that does not resolve to a fixed sha may result in new checkouts in the cache.
### Configuration
Downloaded git dirs and working trees are stored in the gitlibs cache dir, ~/.gitlibs by default. This directory is just a cache and can be safely removed if needed.
tools.gitlibs can be configured by either environment variable or Java system property. If both are provided, the Java system property takes precedence.
| Env var | Java system property | default | description
| ------- | -------------------- | ------- | -----------
| GITLIBS | clojure.gitlibs.dir | ~/.gitlibs | Local directory cache for git repos and working trees |
| GITLIBS_COMMAND | clojure.gitlibs.command | git | git command to run when shelling out (supply full path if needed) |
| GITLIBS_DEBUG | clojure.gitlibs.debug | false | If true, print git commands and output to stderr |
| GITLIBS_TERMINAL | clojure.gitlibs.terminal | false | If true, interactively prompt if needed |
## Example Usage
```clojure
(require '[clojure.tools.gitlibs :as gl])
;; Given a git repo url and a rev, resolve to a full sha.
(gl/resolve "https://github.com/clojure/spec.alpha.git" "739c1af")
;; => "739c1af56dae621aedf1bb282025a0d676eff713"
;; Given a git repo url, library identifier, and a rev, return a path to the working tree
(gl/procure "https://github.com/clojure/spec.alpha.git" 'org.clojure/spec.alpha "739c1af")
;; => "/Users/me/.gitlibs/libs/org.clojure/spec.alpha/739c1af56dae621aedf1bb282025a0d676eff713"
;; Given git repo url, and a collection of revs, return the full sha of the one commit that is
;; a descendant of all other revs or nil if no such rev exists in the collection.
(gl/descendant "https://github.com/clojure/spec.alpha.git" ["607aef0" "739c1af"])
;; => "739c1af56dae621aedf1bb282025a0d676eff713"
```
## Release Information
This project follows the version scheme MAJOR.MINOR.COMMITS where MAJOR and MINOR provide some relative indication of the size of the change, but do not follow semantic versioning. In general, all changes endeavor to be non-breaking (by moving to new names rather than by breaking existing names). COMMITS is an ever-increasing counter of commits since the beginning of this repository.
Latest release: 2.6.206
* [All released versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22tools.gitlibs%22)
* Coordinates: `org.clojure/tools.gitlibs {:mvn/version "2.6.206"}`
# Developer Information
* [GitHub project](https://github.com/clojure/tools.gitlibs)
* [Bug Tracker](https://dev.clojure.org/jira/browse/TDEPS) - if you don't have an acct there, please ask at [Ask Clojure](https://ask.clojure.org)
* [How to contribute](https://clojure.org/dev/dev)
* [Continuous Integration](https://github.com/clojure/tools.gitlibs/actions/workflows/test.yml)
# Copyright and License
Copyright © Rich Hickey, Alex Miller, and contributors
All rights reserved. The use and
distribution terms for this software are covered by the
[Eclipse Public License 1.0] which can be found in the file
epl-v10.html at the root of this distribution. By using this software
in any fashion, you are agreeing to be bound by the terms of this
license. You must not remove this notice, or any other, from this
software.
[Eclipse Public License 1.0]: https://opensource.org/license/epl-1-0/