From bd8532afdcf36b061d1e903b270e6a8dd7d96636 Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Sun, 4 Aug 2019 06:58:15 +0800 Subject: [PATCH] docs: update markdown format --- DOCS.md | 10 +++++----- README.md | 36 ++++++++++++++++++------------------ 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/DOCS.md b/DOCS.md index 2685e01..c4a25cf 100644 --- a/DOCS.md +++ b/DOCS.md @@ -1,8 +1,8 @@ --- -date: 2017-01-29T00:00:00+00:00 +date: 2019-08-04T00:00:00+00:00 title: SSH author: appleboy -tags: [ publish, ssh ] +tags: [ deploy, publish, ssh ] repo: appleboy/drone-ssh logo: term.svg image: appleboy/drone-ssh @@ -124,13 +124,13 @@ pipeline: username: root password: 1234 port: 22 -+ envs: ++ envs: - aws_access_key_id script: - export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID ``` -# Secret Reference +## Secret Reference ssh_username : account for target host user @@ -150,7 +150,7 @@ proxy_ssh_password proxy_ssh_key : plain text of user private key for proxy server -# Parameter Reference +## Parameter Reference host : target hostname or IP diff --git a/README.md b/README.md index 6d0a5fc..87abecb 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ - - # drone-ssh -[![GitHub tag](https://img.shields.io/github/tag/appleboy/drone-ssh.svg)](https://github.com/appleboy/drone-ssh/releases) -[![GoDoc](https://godoc.org/github.com/appleboy/drone-ssh?status.svg)](https://godoc.org/github.com/appleboy/drone-ssh) +![sshlog](images/ssh.png) + +[![GitHub tag](https://img.shields.io/github/tag/appleboy/drone-ssh.svg)](https://github.com/appleboy/drone-ssh/releases) +[![GoDoc](https://godoc.org/github.com/appleboy/drone-ssh?status.svg)](https://godoc.org/github.com/appleboy/drone-ssh) [![Build Status](https://cloud.drone.io/api/badges/appleboy/drone-ssh/status.svg)](https://cloud.drone.io/appleboy/drone-ssh) -[![codecov](https://codecov.io/gh/appleboy/drone-ssh/branch/master/graph/badge.svg)](https://codecov.io/gh/appleboy/drone-ssh) -[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/drone-ssh)](https://goreportcard.com/report/github.com/appleboy/drone-ssh) +[![codecov](https://codecov.io/gh/appleboy/drone-ssh/branch/master/graph/badge.svg)](https://codecov.io/gh/appleboy/drone-ssh) +[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/drone-ssh)](https://goreportcard.com/report/github.com/appleboy/drone-ssh) [![Docker Pulls](https://img.shields.io/docker/pulls/appleboy/drone-ssh.svg)](https://hub.docker.com/r/appleboy/drone-ssh/) -[![](https://images.microbadger.com/badges/image/appleboy/drone-ssh.svg)](https://microbadger.com/images/appleboy/drone-ssh "Get your own image badge on microbadger.com") +[![micro badger](https://images.microbadger.com/badges/image/appleboy/drone-ssh.svg)](https://microbadger.com/images/appleboy/drone-ssh "Get your own image badge on microbadger.com") Drone plugin to execute commands on a remote host through SSH. For the usage information and a listing of the available options please take a look at [the docs](http://plugins.drone.io/appleboy/drone-ssh/). @@ -49,29 +49,29 @@ The pre-compiled binaries can be downloaded from [release page](https://github.c With `Go` installed +```sh +go get -u -v github.com/appleboy/drone-ssh ``` -$ go get -u -v github.com/appleboy/drone-ssh -``` or build the binary with the following command: -``` -$ export GOOS=linux -$ export GOARCH=amd64 -$ export CGO_ENABLED=0 -$ export GO111MODULE=on +```sh +export GOOS=linux +export GOARCH=amd64 +export CGO_ENABLED=0 +export GO111MODULE=on -$ go test -cover ./... +go test -cover ./... -$ go build -v -a -tags netgo -o release/linux/amd64/drone-ssh . +go build -v -a -tags netgo -o release/linux/amd64/drone-ssh . ``` ## Docker Build the docker image with the following commands: -``` -$ make docker +```sh +make docker ``` ## Usage