https://github.com/semrel-extra/tagtower
Tag-driven git index
https://github.com/semrel-extra/tagtower
git tag
Last synced: 3 months ago
JSON representation
Tag-driven git index
- Host: GitHub
- URL: https://github.com/semrel-extra/tagtower
- Owner: semrel-extra
- License: mit
- Created: 2023-09-20T12:47:17.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2026-04-03T00:36:58.000Z (3 months ago)
- Last Synced: 2026-04-03T10:45:43.086Z (3 months ago)
- Topics: git, tag
- Language: TypeScript
- Homepage:
- Size: 3.64 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tagtower
[](https://codeclimate.com/github/semrel-extra/tagtower/maintainability)
[](https://codeclimate.com/github/semrel-extra/tagtower/test_coverage)
[](https://www.npmjs.com/package/tagtower)
> Tag-driven git index
## Motivation
It does not seem possible [to get commits info w/o repo cloning](https://stackoverflow.com/questions/20055398/is-it-possible-to-get-commit-logs-messages-of-a-remote-git-repo-without-git-clon). This limitation brings a significant performance impact on [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/) driven release flows (especially if [git notes](https://git-scm.com/docs/git-notes) API is not supported by VCS). But what if we'd have a side index with web-hooks triggers instead. Let's find out.
_— Looks like a kv-storage based on git tags. This is madness._
_— True._
As a part of «how self-sufficient git is» research.
## Install
```sh
yarn add tagtower
```
## Usage
```ts
import {createTower} from 'tagtower'
const tower = createTower({
url: 'https://github.com/git/repo.git',
branch: 'tagtower', // Branch for storing tags. Defaults to 'tagtower'
temp: './temp', // Dir to hold temporary git channels. Defaults to fs.mkdtemp(path.join(os.tmpdir(), 'tempy-tagtower-'))
committerName: 'Foo Bar', // Username and email to sign annotaged git tags
committerEmail: 'foo@bar.baz', // Defaults to Semrel Extra Bot
format: v => v + '', // Opt value formatter. Defaults to JSON.stringify
parse: v => v, // Opt parser. Defaults to JSON.parse
filter: v => v % 2 // Opt low level filter (applied before parse). Defaults to () => true
})
const id: string = 'some@tag'
const data: Record = {
hash: '3f9f0a88b411a8932bce289a3dd498d70a4dc96c',
author: 'Anton Golub ',
message: 'feat: initial feat'
}
await tower.create(id, data) // stores entry to the specified remote
await tower.read(id) // returns found TEntry | null
await tower.read() // if tag is empty, returns TEntry[]
await tower.update(id, data) // just a shortcut for delete & create
await tower.delete(id) // void
```
## License
[MIT](./LICENSE)