https://github.com/greenkeeperio/greenkeeper-postpublish
Useful for using non-npm registries with GitHub Enterprise
https://github.com/greenkeeperio/greenkeeper-postpublish
Last synced: 6 months ago
JSON representation
Useful for using non-npm registries with GitHub Enterprise
- Host: GitHub
- URL: https://github.com/greenkeeperio/greenkeeper-postpublish
- Owner: greenkeeperio
- Created: 2016-04-01T09:33:56.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-05-24T20:09:15.000Z (over 5 years ago)
- Last Synced: 2025-04-13T15:12:01.869Z (6 months ago)
- Language: JavaScript
- Homepage: https://greenkeeper.io/enterprise
- Size: 43.9 KB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# greenkeeper-postpublish
[](https://greenkeeper.io/)
## Set up greenkeeper-postpublish
To install `greenkeeper-postpublish` save it to your `devDependencies`:
```
npm install greenkeeper-postpublish --save-dev
```
Then add it to your `scripts` in your `package.json`:
```json
"scripts": {
"postpublish": "greenkeeper-postpublish --secret=$GK_NPMHOOK_SECRET --installation=$GK_INSTALLATION_ID"
}
```
You can also set the `secret` and `installation` values in your publish environment:
```
gk_secret=$GK_NPMHOOK_SECRET
gh_installation=$GK_INSTALLATION_ID
```
Where the `GK_NPMHOOK_SECRET` is set in your Greenkeeper Enterprise Admin Dashboard at https://gke.your-company.com:8800 and `GK_INSTALLATION_ID` can be found in your GitHub Enterprise setup on the organisation for your modules: https://ghe.your-company.com/organizations/$organisation_name/settings/installations -> Greenkeeper -> the integer number in the URL.
When set up like this, every time your release the package (with `npm publish`),
it will let Greenkeeper know that there is a new version available.
## Manual use
You can also run it outside of the `package.json` scripts. You will need to install
it with the `--global` flag then though:
```
npm install greenkeeper-postpublish --global
```
If you run `greenkeeper-postpublish` in a directory with a `package.json` it will
parse it and use its `name` and `version`.
You can also specify the `--pkgname` and `--pkgversion` parameters instead:
```
greenkeeper-postpublish --pkgname mypackage --pkgversion 4.2.0 --secret=abcd --installation=54321
```
🌴