https://github.com/vanioinformatika/docker-publish
Zero-Configuration Docker Publishing from npm
https://github.com/vanioinformatika/docker-publish
docker nodejs npm npm-script
Last synced: about 14 hours ago
JSON representation
Zero-Configuration Docker Publishing from npm
- Host: GitHub
- URL: https://github.com/vanioinformatika/docker-publish
- Owner: vanioinformatika
- License: mit
- Created: 2017-02-14T09:42:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T18:48:07.000Z (almost 3 years ago)
- Last Synced: 2025-09-09T06:20:06.388Z (about 1 month ago)
- Topics: docker, nodejs, npm, npm-script
- Language: JavaScript
- Size: 219 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Docker Publish
Simple Docker tagging and publishing with 'npm version'
## Prerequisite
Do not forget **installing docker** and running **docker login** before using it!
Install:
```
npm i -D @vanioinformatika/docker-publish
```
## Best practice
**Using npm run postversion:** building image, creating docker tags and push into Docker Registry with one command.
In package.json set _postversion:_
```
"preversion": "docker -v && git push && npm install && npm test",
"version": "",
"postversion": "git push && git push --tags && docker build -t $npm_package_config_docker_ns/$npm_package_name:latest . && docker-publish"
```
or with hands:
```
docker build -t namespace/appname:latest .
node ./node_modules/.bin/docker-publish
```
## Configuration
There is **zero configuration.** All parameters comes from package.json: *$npm_package_name* and *$npm_package_version* variable (name and version properties).
_* Maybe you want to use your own private docker repository, in this case please see the next chapter._
### Customization
Optionally, in package.json you can customize your docker properties:
```json
"version": "1.3.5",
"name": "docker-publish",
"config": {
"docker": {
"ns": "namespace",
"url": "docker.yourcompany.com:5000",
"name": "myapp",
"skip": false,
"silence": false,
"strictSemver": false
}
}
```
CLI parameters could overwites package.json properties (except version number).
- **DOCKER_NS:** your namespace for image; _namespace/imagename:tag_ Default: empty
- **DOCKER_URL:** your private docker repository URL; _docker.yourcompany.com:5000_
- **DOCKER_NAME:** overwrite image name. Default: package.json _name_ properties
- **DOCKER_SKIP:** Skip Docker tag and push commands (dry run with logging). Default: false
- **DOCKER_SILENCE:** Do not logging. Default: false
- **DOCKER_STRICT_SEMVER:** Strict semantic versioning tag. Default: false. If it is true, then only one tag will be created on docker image as https://semver.org defined and there is no 'v' before version number.
## Releasing
**Best practice:** _postversion_ contains **image building** and **docker-publish,** and running **npm version**
Output:
```
docker tag docker-publish:latest docker-publish:v1
docker tag docker-publish:latest docker-publish:v1.3
docker tag docker-publish:latest docker-publish:v1.3.5
docker tag docker-publish:latest docker-publish:v1.3.5-RELEASE-g993df1b
docker tag docker-publish:latest docker-publish:latest
docker push docker-publish:v1
docker push docker-publish:v1.3
docker push docker-publish:v1.3.5
docker push docker-publish:v1.3.5-RELEASE-g993df1b
docker push docker-publish:latest
```
*v1.3.5-RELEASE-g993df1b:* v1.3.5 - your version number from project.json, g993df1b - git commit ID (7 chars)
If DOCKER_STRICT_SEMVER, strictSemver is *true,* then:
```
docker tag docker-publish:latest docker-publish:1.3.5
docker push docker-publish:1.3.5
```
## Snapshot
If you want to publish a _snapshot_, the image will be tagged with git commit id, and the commit's number since last version, and pushed. If DOCKER_STRICT_SEMVER, strictSemver is *true,* then snapshot is not available.
Output:
```
docker tag docker-publish:latest docker-publish:v1.3.4-5-gb4c008b
docker push docker-publish:v1.3.4-1-gb4c008b
```
*v1.3.5-RELEASE-g993df1b:* v1.3.5 - your version number from project.json, 5 - commit's number since v1.3.4 tag, gb4c008b - last (fifth) git commit ID (7 chars
If you have never tagged git commit, then tag shows:
```
skipped: docker tag docker-publish:latest docker-publish:0bd4c74
skipped: docker push docker-publish:0bd4c74
```
Where _0bd4c74_ is the last commit id.