Skip to content

Commit

Permalink
Merge branch 'release/v2'
Browse files Browse the repository at this point in the history
  • Loading branch information
@thematchless
thematchless committed Oct 2, 2021
2 parents 4daafe1 + f888c25 commit 13a7151
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Build and publish Docker image](https://github.com/thematchless/bump-image-version-action/actions/workflows/build.yml/badge.svg)](https://github.com/thematchless/bump-image-version-action/actions/workflows/build.yml)

# Bump docker image version on a remote host
This repository contains an GitHub action to bump up a docker image version specified in your docker-compose stack.

Expand All @@ -6,5 +8,34 @@ This repository contains an GitHub action to bump up a docker image version spec
- you have a ssh private and public key to authenticate via ssh
- you have saved your private and public key to the GitHub project secrets

## Configuration options for the action

| required | key | example | default | description |
|:------------------:|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|----------------------------------------------------------|
| :white_check_mark: | remote_docker_host | thematchless@fancyServer.de | | username@host |
| :white_check_mark: | ssh_private_key | -----BEGIN OPENSSH PRIVATE KEY----<br>UgAAAAtzc2gtZWQyNTUxOQAAACALBUg<br>UgAAAAtzc2gtZWQyNTUxOQAAACALBUg<br>UgAAAAtzc2gtZWQyNTUxOQAAACALBUg<br>-----END OPENSSH PRIVATE KEY----- | | private key in PEM format |
| :white_check_mark: | ssh_public_key | ssh-ed25519 ABCDABCDu027374972309 | | public key of the PEM |
| :white_check_mark: | service_name | super-fancy-react-app | | name of the service inside of the compose file |
| :white_check_mark: | deploy_path | /home/thematchless/stack-1 | | path which contains your compose file on the remote host |
| :white_check_mark: | args | up -d | | arguments how to start your service |
| :x: | stack_file_name | docker-compose.yaml | docker-compose.yml | name of the compose file |
| :x: | remote_docker_port | 1337 | 22 | ssh port on the host |
| :x: | pull_images_first | true | false | flag to force the image pull before starting |


## Example GitHub action task
```yaml
- name: Deploy on Remote Server
uses: thematchless/bump-image-version-action@latest
with:
remote_docker_host: thematchless@fancyServer.de
ssh_private_key: ${{ secrets.REMOTE_SSH_PRIVATE_KEY }}
ssh_public_key: ${{ secrets.REMOTE_SSH_PUBLIC_KEY }}
service_name: super-fancy-react-app
deploy_path: /home/thematchless/stack-1
args: up -d
pull_images_first: true
```

## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.
4 changes: 4 additions & 0 deletions docker-entrypoint.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ if [ -z "$INPUT_ARGS" ]; then
exit 1
fi

if [ -z "$INPUT_PULL_IMAGES_FIRST" ]; then
INPUT_PULL_IMAGES_FIRST=false
fi

if [ -z "$INPUT_STACK_FILE_NAME" ]; then
INPUT_STACK_FILE_NAME=docker-compose.yml
fi
Expand Down

0 comments on commit 13a7151

Please sign in to comment.