https://github.com/olliephillips/pipeline

Building a template repo using test & build tools with Github Actions. Optimised for Go
https://github.com/olliephillips/pipeline

build deepsource go golang pipeline test

Last synced: 18 days ago
JSON representation

Building a template repo using test & build tools with Github Actions. Optimised for Go

• Host: GitHub
• URL: https://github.com/olliephillips/pipeline
• Owner: olliephillips
• License: mpl-2.0
• Created: 2022-04-19T09:16:19.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-04-21T14:28:56.000Z (almost 4 years ago)
• Last Synced: 2024-06-20T06:36:40.236Z (over 1 year ago)
• Topics: build, deepsource, go, golang, pipeline, test
• Language: Go
• Homepage:
• Size: 41 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Pipeline

## A repo/pipeline template for tests, code quality/security review and artifact build

Building a template repo using test & build tools with Github Actions. Optimised for Go.

[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/olliephillips/pipeline?style=flat-square)](https://go.dev/)

[![Go Report Card](https://goreportcard.com/badge/github.com/olliephillips/pipeline?style=flat-square)](https://goreportcard.com/report/github.com/olliephillips/pipeline)

[![DeepSource](https://deepsource.io/gh/olliephillips/pipeline.svg/?label=active+issues&token=uYY_4Kwjq9MnjT7TzykEyv-J)](https://deepsource.io/gh/olliephillips/pipeline/?ref=repository-badge)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/olliephillips/pipeline/Build?style=flat-square)](https://github.com/olliephillips/pipeline/actions/workflows/build.yml)

[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/olliephillips/pipeline/Unit%20Test/master?label=tests&style=flat-square)](https://github.com/olliephillips/pipeline/actions/workflows/unit_test.yml)

[![GitHub Release Date](https://img.shields.io/github/release-date/olliephillips/pipeline?style=flat-square)](https://github.com/olliephillips/pipeline/releases)

[![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/olliephillips/pipeline/latest?style=flat-square)](https://github.com/olliephillips/pipeline/commits)

[![GitHub](https://img.shields.io/github/license/olliephillips/pipeline?label=license&style=flat-square)](LICENSE)

## Using

Download as a zip file rather than clone or fork the repository. Then run `git init` in your code folder. 

Or, clone/fork it and delete the `.git` folder, and then run `git init`.

- DeepSource and Twitter will need secrets to be set up in your repository if need to use.

- [README.md](README.md) will need badge assets to be edited to suit Github account and repository name.

### Unit Tests

Tests are run on 'push' and 'pull request' to main/master.

### Build

Software is built on 'push' and 'pull request' to main/master. Will it build!?

### Code Quality & Security

Code quality, security and test coverage is monitored using [DeepSource](https://deepsource.io).

### Releases

Releases are built for target OS using GoReleaser. Create a tag, push it.

Latest release is [at this generic link here](https://github.com/olliephillips/pipeline/releases/latest)

This is typical is the git create tag & push tag syntax.

```bash

git tag -a v0.0.1 -m "Test release"

git push origin v0.0.1

```

### Branch protection

Within Github, we've configured a rule to prevent direct push to master.  As an admin my commits don't hit that protection.

### Badges

Various Github & Deepsource badges are being used. Mostly done via [Sheilds.io](https://shields.io)

### Announcements

New releases will be announced to Twitter (requires Twitter's elevated developer access).

### Todo

- Main branch

### License

Licensed under [Mozilla Public License 2.0](LICENSE)