Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramasilveyra/gitpkg
Publish packages as git tags
https://github.com/ramasilveyra/gitpkg
git gitpkg modules package private
Last synced: 20 days ago
JSON representation
Publish packages as git tags
- Host: GitHub
- URL: https://github.com/ramasilveyra/gitpkg
- Owner: ramasilveyra
- License: mit
- Created: 2017-06-23T16:37:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T20:20:22.000Z (almost 2 years ago)
- Last Synced: 2024-09-21T09:12:02.194Z (3 months ago)
- Topics: git, gitpkg, modules, package, private
- Language: JavaScript
- Homepage:
- Size: 771 KB
- Stars: 273
- Watchers: 5
- Forks: 27
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - ramasilveyra/gitpkg - Publish packages as git tags (JavaScript)
README
gitpkg
Publish packages as git tags
🔧 Works with projects with build steps.
👯 Works with projects with multiple packages (monorepos).
🏎 Lightweight git tags (only the files needed are included).
Table of Contents
- [Background](#background)
- [Terminology](#terminology)
- [Install](#install)
- [Usage](#usage)
- [Publish](#publish)
- [Contribute](#contribute)
- [Troubleshooting](#troubleshooting)
- [License](#license)
Background
Both npm and yarn support installing packages from git tags.
But things can get difficult with packages that have a build step (eg [babel](https://github.com/babel/babel)) and monorepos with multiples packages (eg [lerna](https://github.com/lerna/lerna)).
`gitpkg publish` creates a git tag with the same files as if you were running `npm publish` or `yarn publish` and uploads the generated git tag to a git repository.
Also you can publish any gitpkg package to the same repository, so you can have only one repository used as common registry and you get away from your project git repository the git tags with the build code.
### Terminology:
- **gitpkg package**: git tag generated by gitpkg.
- **gitpkg registry**: git repository used as common host for your gitpkg packages.
Install
**Node.js v10.12 or newer** is required.
### npm registry
Via the yarn client:
```bash
$ yarn global add gitpkg
```
Via the npm client:
```bash
$ npm install -g gitpkg
```
### gitpkg registry
Via the yarn client:
```bash
$ yarn global add ramasilveyra/public-registry#gitpkg-v1.0.0-beta.2-gitpkg
```
Via the npm client:
```bash
$ npm install -g ramasilveyra/public-registry#gitpkg-v1.0.0-beta.2-gitpkg
```
Usage
### Publish
Publishes a package to a git repository, by default uploads the package to the git repository in the git remote origin (`git remote -v` to see your git remote origin url). The package published is defined by the package.json in the current directory.
```bash
$ gitpkg publish
```
[See in action](https://user-images.githubusercontent.com/7464663/27548379-318b38f8-5a6f-11e7-978c-b5a2f6677e61.gif).
#### --registry, -r
```bash
$ gitpkg publish --registry [email protected]:org/private-registry.git
```
This flag tells gitpkg to publish the package to a specific gitpkg registry.
You can also set the gitpkg registry permanently by adding `"gitpkg":{"registry":"[email protected]:org/private-registry.git"}` to the package.json.
Configuration
You can also configure gitpkg with a config file. Create a file named `gitpkg.config.js` in the root of your project or in the root of a subpackage.
### Available config settings
#### registry
Publish the package to a specific gitpkg registry. Same as the registry flag of the cli.
#### getTagName
Function used to create the git tags. The function receives one object `pkg`, which is the content of the package.json file.
```js
// Example content of gitpkg.config.js
module.exports = () => ({
registry: '[email protected]:org/private-registry.git',
getTagName: pkg => `${pkg.name}-v${pkg.version}-gitpkg`
});
```
Troubleshooting
## Usage with Gerrit
gitpkg works by publishing tags that contain only the files in a package. The commits in these tags don't appear on any branch, so Gerrit will reject them by default:
```
! [remote rejected] …
(prohibited by Gerrit: update for creating new commit object not permitted)
```
To gain the permission gitpkg needs, add **Create Reference** and **Push** entries to the `refs/tags/*` reference in the _Access_ settings of your repository.
Contribute
Feel free to dive in! [Open an issue](https://github.com/ramasilveyra/gitpkg/issues/new) or submit PRs.
gitpkg follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) Code of Conduct.
License
[MIT © Ramiro Silveyra d'Avila](LICENSE.md)