Ecosyste.ms: Awesome

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

https://github.com/invidian/terraform-provider-sshcommand

This provider allow to execute commands remotely via SSH and capture the output from them.
https://github.com/invidian/terraform-provider-sshcommand

Last synced: 21 days ago
JSON representation

This provider allow to execute commands remotely via SSH and capture the output from them.

Host: GitHub
URL: https://github.com/invidian/terraform-provider-sshcommand
Owner: invidian
License: mit
Created: 2019-04-12T12:52:28.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2020-11-22T16:12:19.000Z (over 3 years ago)
Last Synced: 2024-02-18T18:41:54.190Z (4 months ago)
Language: Go
Size: 126 KB
Stars: 16
Watchers: 5
Forks: 4
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-stars - invidian/terraform-provider-sshcommand - This provider allow to execute commands remotely via SSH and capture the output from them. (Go)

README

        # SSH Command Terraform Provider [![Build Status](https://travis-ci.com/invidian/terraform-provider-sshcommand.svg?branch=master)](https://travis-ci.com/invidian/terraform-provider-sshcommand) [![Maintainability](https://api.codeclimate.com/v1/badges/8ba444c9af4028639135/maintainability)](https://codeclimate.com/github/invidian/terraform-provider-sshcommand/maintainability) [![codecov](https://codecov.io/gh/invidian/terraform-provider-sshcommand/branch/master/graph/badge.svg)](https://codecov.io/gh/invidian/terraform-provider-sshcommand) [![Go Report Card](https://goreportcard.com/badge/github.com/invidian/terraform-provider-sshcommand)](https://goreportcard.com/report/github.com/invidian/terraform-provider-sshcommand)

This provider allow to execute commands remotely via SSH and capture the output from them.

This provider uses built-in [crypto/ssh](https://godoc.org/golang.org/x/crypto/ssh) Golang library to act as a SSH Client. Currently the implementation is very limited, but can be easily extended.

## Table of contents

* [User documentation](#user-documentation)

* [Building and testing](#building-and-testing)

* [Authors](#authors)

## User documentation

For user documentation, see [Terraform Registry](https://registry.terraform.io/providers/invidian/sshcommand/latest/docs).

## Building

For testing builds, simply run `docker build .`, which will download all dependencies, run build, test and linter.

For local builds, run `make` which will build the binary, run unit tests and linter.

## Releasing

This project use `goreleaser` for releasing. To release new version, follow the following steps:

* Add a changelog for new release to CHANGELOG.md file.

* Tag new release on desired git, using example command:

  ```sh

  git tag -a v0.4.7 -s -m "Release v0.4.7"

  ```

* Push the tag to GitHub

  ```sh

  git push origin v0.4.7

  ```

* Run `goreleser` to create a GitHub Release:

  ```sh

  GITHUB_TOKEN=githubtoken GPG_FINGERPRINT=gpgfingerprint goreleaser release --release-notes <(go run github.com/rcmachado/changelog show 0.4.7)

  goreleaser

  ```

* Go to newly create [GitHub release](https://github.com/invidian/terraform-provider-sshcommand/releases/tag/v0.4.7), verify that the changelog

  and artefacts looks correct and publish it.

## Authors

* **Mateusz Gozdek** - *Initial work* - [invidian](https://github.com/invidian)