Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crucibuild/cookiecutter-agent-go
A cookiecutter template to create new Crucibuild Agents in Go following best practices.
https://github.com/crucibuild/cookiecutter-agent-go
agent cookiecutter crucibuild go
Last synced: about 1 month ago
JSON representation
A cookiecutter template to create new Crucibuild Agents in Go following best practices.
- Host: GitHub
- URL: https://github.com/crucibuild/cookiecutter-agent-go
- Owner: crucibuild
- License: apache-2.0
- Created: 2017-07-13T07:33:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-23T20:02:17.000Z (over 7 years ago)
- Last Synced: 2024-08-01T13:28:25.677Z (4 months ago)
- Topics: agent, cookiecutter, crucibuild, go
- Language: Go
- Size: 15.6 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - crucibuild/cookiecutter-agent-go - A cookiecutter template to create new Crucibuild Agents in Go following best practices. (Go)
README
cookiecutter-agent-go
=====================
[](http://yeoman.io)
[](https://travis-ci.org/crucibuild/cookiecutter-agent-go)
> A [cookiecutter] template to create new [Crucibuild] Agents in [Go] following best practices.
## Features
The template scaffolds a _project_ with a minimal implementation of a Crucibuild agent, including:
* the agent manifest
* a Makefile managing the project build:
* installation of the all necessary go dependencies
* code generation of the static resources using [go-resources](https://github.com/omeid/go-resources/cmd/resources)
* check of Go sources for errors and warnings using [gometalinter](https://github.com/alecthomas/gometalinter)
* built of the agent
* TravisCI integration.
## Installation
##### Prerequisites
The following must be installed and available:
- [Python]
- [Go]
##### Project
Install [cookiecutter] using the following command line:
```sh
$ pip install cookiecutter
```
alternatively you can install cookiecutter with `homebrew`:
```sh
$ brew install cookiecutter
```
## Usage
To create a new Crucibuild agent, just run `cookiecutter` with this template by typing:
```sh
$ cookiecutter https://github.com/crucibuild/cookiecutter-agent-go
```
You'll be prompted for various configuration options (see `cookiecutter.json` for the full list).
Finally, enter the project and take a look around:
```sh
$ cd
$ ls
```
You can build the agent using the make command:
```sh
$ make
```
[Python]: https://www.python.org/
[Go]: https://golang.org/
[cookiecutter]: https://github.com/audreyr/cookiecutter
[Crucibuild]: https://github.com/crucibuild