Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/felixfbecker/semantic-release-docker

🐳 Set of semantic-release plugins to publish to DockerHub
https://github.com/felixfbecker/semantic-release-docker

Last synced: 10 days ago
JSON representation

🐳 Set of semantic-release plugins to publish to DockerHub

Host: GitHub
URL: https://github.com/felixfbecker/semantic-release-docker
Owner: felixfbecker
License: mit
Created: 2017-11-22T10:56:39.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2021-11-09T20:02:05.000Z (about 3 years ago)
Last Synced: 2024-11-30T02:45:58.170Z (14 days ago)
Language: JavaScript
Homepage:
Size: 96.7 KB
Stars: 76
Watchers: 4
Forks: 14
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # semantic-release-docker

[![npm](https://img.shields.io/npm/v/semantic-release-docker.svg)](https://www.npmjs.com/package/felixfbecker/semantic-release-docker)

[![build](https://img.shields.io/travis/felixfbecker/semantic-release-docker.svg)](https://travis-ci.org/felixfbecker/semantic-release-docker)

[![downloads](https://img.shields.io/npm/dt/semantic-release-docker.svg)](https://www.npmjs.com/package/semantic-release-docker)

[![dependencies](https://img.shields.io/david/felixfbecker/semantic-release-docker.svg)](https://david-dm.org/felixfbecker/semantic-release-docker)

[![peerDependencies](https://david-dm.org/felixfbecker/semantic-release-docker/peer-status.svg)](https://david-dm.org/felixfbecker/semantic-release-docker?type=peer)

[![Greenkeeper](https://badges.greenkeeper.io/felixfbecker/semantic-release-docker.svg)](https://greenkeeper.io/)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![license](https://img.shields.io/npm/l/semantic-release-docker.svg)](https://github.com/felixfbecker/semantic-release-docker/blob/master/LICENSE)

Set of [semantic-release](https://github.com/semantic-release/semantic-release) plugins for publishing a docker image to

[Docker Hub](https://hub.docker.com/).

```json

{

  "release": {

    "verifyConditions": {

      "path": "semantic-release-docker",

      "registryUrl": "docker.io"

    },

    "publish": {

      "path": "semantic-release-docker",

      "name": "username/imagename"

    }

  }

}

```

## Configuration

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

In addition, you need to specify the name of the image as the `name` setting in the publish step. If you need to specify a custom docker registry URL, add it as the `registryUrl` setting in the verifyConditions step.

## Plugins

### `verifyConditions`

Verify that all needed configuration is 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` tag.

## Example .travis.yml

```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

```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?

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](https://github.com/semantic-release/exec) for example.

```json

{

  "plugins": [

    ["@semantic-release/exec", {

      "prepareCmd": "docker build -t username/imagename ."

    }],

    ["semantic-release-docker", {

      "name": "username/imagename"

    }]

  ]

}

```