Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@semantic-release-plus/docker

Package Overview
Dependencies
Maintainers
1
Versions
50
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@semantic-release-plus/docker

semantic-release plugin to release a docker container

  • 2.3.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
929
increased by33.29%
Maintainers
1
Weekly downloads
 
Created
Source

@semantic-release-plus/docker

npm downloads code style: prettier semantic-release-plus license

A semantic-release-plus or semantic-release plugin for publishing a docker images to a docker registry.

Key features

  • Automatically gets next version based on commit history (semantic-release-plus/semantic-release)
  • publishes latest tag
  • publishes major tag
  • publishes minor tag
  • publish to docker hub or other registry
{
  "release": {
    "plugins": [
      [
        "@semantic-release-plus/docker",
        {
          "name": "my-cool-docker-app",
          "publishLatestTag": true,
          "publishMajorTag": true,
          "publishMinorTag": true
        }
      ]
    ]
  }
}

Publishing Latest, Major, and Minor tags is a pattern followed by a number of docker images.

Configuration

Your credentials have to be configured with the environment variables DOCKER_USERNAME and DOCKER_PASSWORD.

OptionDescriptionTypeDefault
nameRequired config associated with the tag name assigned to the image during build docker build -t namestring
registryUrlThe docker registry url to publishstringdocker.io
publishLatestTagPublishes/Updates name:latest tag to point at the latest releasebooleantrue
publishMajorTagIf releasing v3.2.1 Publishes/Updates name:3 to the latest releasebooleanfalse
publishMinorTagIf releasing v3.2.1 Publishes/Updates name:3.2 to the latest releasebooleanfalse

Plugins

verifyConditions

Verify that all needed configuration are present and login to the Docker registry.

publish

Tag the image specified by name with the new version, push it to Docker Hub and update the latest, major, minor tags based on the configuration.

Example .travis.yml

jobs:
  include:
    - stage: release
      language: node_js
      node_js: '8'
      services:
        - docker
      script:
        - docker build -t username/imagename .
        - npm run semantic-release

stages:
  - test
  - name: release
    if: branch = master AND type = push AND fork = false

branches:
  except:
    - /^v\d+\.\d+\.\d+$/

Circle CI Example .config.yml

version: 2
jobs:
  release:
    docker:
      - image: circleci/node:8
    steps:
      - setup_remote_docker:
          docker_layer_caching: true
      - run:
          name: release
          command: |
            docker build -t username/imagename .
            npm run semantic-release

workflows:
  version: 2
  pipeline:
    jobs:
      - test
      - release:
          requires:
            - test
          filters:
            branches:
              only: master

Note that setup_remote_docker step is required for this plugin to work in Circle CI environment

How to keep new version in package.json inside docker image?

It is best to let semantic-release focus on releasing your built artifact and not extend semantic-release to also do the build. I recommend using semantic-release-plus to get the next version without creating a tag then using that durning your build process. An example of this can be found in the semantic-release-plus Expected next version recipe.

Deprecated Process

In order to do that you need to run docker build command during semantic-release prepareCmd event.~~

It can be done with help of @semantic-release/exec for example.~~

{
  "plugins": [
    [
      "@semantic-release/exec",
      {
        "prepareCmd": "docker build -t username/imagename ."
      }
    ],
    [
      "@semantic-release-plus/docker",
      {
        "name": "username/imagename"
      }
    ]
  ]
}

Migrated to Nx monorepo

This library was generated with Nx.

Running unit tests

Run ng test plugins-docker to execute the unit tests via Jest.

FAQs

Package last updated on 06 Jun 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc