cicd/drone-ssh
1
0
Fork 0
mirror of https://github.com/appleboy/drone-ssh.git synced 2025-05-09 18:23:21 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: update markdown format

Browse Source
This commit is contained in:
Bo-Yi Wu 2019-08-04 06:58:15 +08:00
parent 44cc1f409f
commit bd8532afdc
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
DOCS.md
View File

@ -1,8 +1,8 @@
--- ---
date: 2017-01-29T00:00:00+00:00 date: 2019-08-04T00:00:00+00:00
title: SSH title: SSH
author: appleboy author: appleboy
tags: [ publish, ssh ] tags: [ deploy, publish, ssh ]
repo: appleboy/drone-ssh repo: appleboy/drone-ssh
logo: term.svg logo: term.svg
image: appleboy/drone-ssh image: appleboy/drone-ssh
@ -124,13 +124,13 @@ pipeline:
username: root username: root
password: 1234 password: 1234
port: 22 port: 22
+ envs: + envs:
- aws_access_key_id - aws_access_key_id
script: script:
- export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID - export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID
``` ```
# Secret Reference ## Secret Reference
ssh_username ssh_username
: account for target host user : account for target host user
@ -150,7 +150,7 @@ proxy_ssh_password
proxy_ssh_key proxy_ssh_key
: plain text of user private key for proxy server : plain text of user private key for proxy server
# Parameter Reference ## Parameter Reference
host host
: target hostname or IP : target hostname or IP

36
README.md
View File

@ -1,14 +1,14 @@
<img src="images/ssh.png">
# drone-ssh # drone-ssh
[![GitHub tag](https://img.shields.io/github/tag/appleboy/drone-ssh.svg)](https://github.com/appleboy/drone-ssh/releases) ![sshlog](images/ssh.png)
[![GoDoc](https://godoc.org/github.com/appleboy/drone-ssh?status.svg)](https://godoc.org/github.com/appleboy/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)
[![Build Status](https://cloud.drone.io/api/badges/appleboy/drone-ssh/status.svg)](https://cloud.drone.io/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) [![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) [![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/) [![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 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/). 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 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: or build the binary with the following command:
``` ```sh
$ export GOOS=linux export GOOS=linux
$ export GOARCH=amd64 export GOARCH=amd64
$ export CGO_ENABLED=0 export CGO_ENABLED=0
$ export GO111MODULE=on 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 ## Docker
Build the docker image with the following commands: Build the docker image with the following commands:
``` ```sh
$ make docker make docker
``` ```
## Usage ## Usage