diff --git a/CHANGELOG.md b/CHANGELOG.md index f022a15..568a094 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ -## next +## 0.1.0 (2022-09-12) - Initial release diff --git a/README.md b/README.md index cba4b01..560608b 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,11 @@ await repo.dispose(); #### createGitReader(gitdir, options?) - `gitdir`: string - path to the git repo -- `options.cruftPacks`: CruftPackMode (default: `'include'`) - controls the inclusion of cruft packs in packed objects procession. - -#### CruftPackMode - -Defines how cruft packs are processed by git reader. Check [git docs](https://git-scm.com/docs/cruft-packs) to learn more about cruft packs. - -- `'include'` - processes all packs (alias `true`) -- `'exclude'` - excludes cruft packs from processing (alias `false`) -- `'only'` - processes cruft packs only +- `options` – optional settings: + - `cruftPacks` – defines how [cruft packs](https://git-scm.com/docs/cruft-packs) are processed: + - `'include'` or `true` (default) - process all packs + - `'exclude'` or `false` - exclude cruft packs from processing + - `'only'` - process cruft packs only ### Refs diff --git a/package-lock.json b/package-lock.json index f7e8600..d4a2108 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@discoveryjs/scan-git", - "version": "0.0.0", + "version": "0.1.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@discoveryjs/scan-git", - "version": "0.0.0", + "version": "0.1.0", "license": "MIT", "dependencies": { "@discoveryjs/scan-fs": "^4.0.0-rc.1" diff --git a/package.json b/package.json index 2ee8ceb..af24ea5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@discoveryjs/scan-git", - "version": "0.0.0", + "version": "0.1.0", "description": "A tool set for fast and efficient git scanning to capture data with focus on large repos", "repository": "discoveryjs/scan-git", "author": "Roman Dvornov ", @@ -8,6 +8,8 @@ "keywords": [ "git", "scan", + "branch", + "tag", "files", "commits", "delta" @@ -60,6 +62,6 @@ "build:transpile": "node scripts/transpile.cjs", "coverage": "c8 --exclude lib-test --reporter=lcovonly npm run test:esm", "watch": "npm run build:transpile -- --watch --types", - "prepublishOnly": "npm run lint && npm run ts-emit-types && npm run build && npm run test" + "prepublishOnly": "npm run lint && rm -rf lib/** && npm run ts-emit-types && npm run build && npm run test" } }