Git Product home page Git Product logo

moul / golang-repo-template Goto Github PK

View Code? Open in Web Editor NEW
297.0 7.0 31.0 2.85 MB

πŸŒ€ A template for creating new Golang + Docker + Canonical Domain + Badges + Dependabot + Renovate + GolangCI-lint + Goreleaser + GitHub Actions + Gitpod + Depaware + Git Hooks + ...

Home Page: https://manfred.life/golang

License: Other

Dockerfile 15.74% Makefile 18.64% Go 50.63% Shell 14.99%
golang template-repository boilerplate docker circleci renovate golangci-lint goreleaser template template-project

golang-repo-template's Introduction

golang-repo-template

πŸ˜„ golang-repo-template

go.dev reference License GitHub release Docker Metrics Made by Manfred Touron

Go Release PR GolangCI codecov Go Report Card CodeFactor

Gitpod ready-to-code

Usage

foo@bar:~$ golang-repo-template
            _                                                   _                      _        _
 __ _  ___ | | __ _  _ _   __ _  ___  _ _  ___  _ __  ___  ___ | |_  ___  _ __   _ __ | | __ _ | |_  ___
/ _` |/ _ \| |/ _` || ' \ / _` ||___|| '_|/ -_)| '_ \/ _ \|___||  _|/ -_)| '  \ | '_ \| |/ _` ||  _|/ -_)
\__, |\___/|_|\__,_||_||_|\__, |     |_|  \___|| .__/\___/      \__|\___||_|_|_|| .__/|_|\__,_| \__|\___|
|___/                     |___/                |_|                              |_|
12 CPUs, /home/moul/.local/bin/golang-repo-template, fwrz, go1.16.5
[]

Install

Using go

go get moul.io/golang-repo-template

Releases

See https://github.com/moul/golang-repo-template/releases

Contribute

Contribute <3

I really welcome contributions. Your input is the most precious material. I'm well aware of that and I thank you in advance. Everyone is encouraged to look at what they can do on their own scale; no effort is too small.

Everything on contribution is sum up here: CONTRIBUTING.md

Dev helpers

Pre-commit script for install: https://pre-commit.com

Contributors ✨

All Contributors

Thanks goes to these wonderful people (emoji key):


Manfred Touron

🚧 πŸ“– ⚠️ πŸ’»

moul-bot

🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

Stargazers over time

Stargazers over time

License

Β© 2021 Manfred Touron

Licensed under the Apache License, Version 2.0 (LICENSE-APACHE) or the MIT license (LICENSE-MIT), at your option. See the COPYRIGHT file for more details.

SPDX-License-Identifier: (Apache-2.0 OR MIT)

golang-repo-template's People

Contributors

allcontributors[bot] avatar dependabot-preview[bot] avatar dependabot[bot] avatar doozers avatar dzalevski avatar moul avatar moul-bot avatar renovate-bot avatar renovate[bot] avatar stavrospanakakis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

golang-repo-template's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

[META] Introduction πŸ‘‹

I regularly use this template for my different projects.
The root README.md is also a template file, so this issue is used to as README.md replacement :)

This template is personal and strongly coupled to myself with my name everywhere, it won't be a real nightmare to replace my name with yours, but I suggest you keep this repo as a reference, pick up your favorite ideas, and do one for yourself :)

What I'm proud of this repo is that it fits with most of my needs with very minimal changes so I can have my project set up in a few minutes.

FYI, here is the command I run just after creating a new repo based on this template:

for file in $(git grep golang-repo-template | cut -d: -f1 | sort -u); do
    sed -i'' s/golang-repo-template/NEWPROJECT/g $file
done

And if the repo is a library without any binary, I've additional things to do, i.e.:

  • removing some files: Dockerfile, package.json, .goreleaser.yml
  • updating some others: Makefile, .github/workflows/*.yml

That's it :)


Btw, feel free to comment this issue or open a new one if you have things to share, questions, suggestions, anything πŸ‘‹

[IDEA] post-fork script

Is your feature request related to a problem? Please describe.

  • always typing the same commands after forking this template
  • have a way of adding more files in the templates and easily remove them if unnecessary

Describe the solution you'd like
A clear and concise description of what you want to happen.

Add script to call just after forking this template to apply the regular changes (mostly sed, rm, etc)

The script should be kept in .github directory and should use a configuration file so we can later add more commands as « update » to get the latest changes applied

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

None

Additional content
Add any other context or screenshots about the feature request here.

[IDEA] add pull request templates

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

dockerfile
Dockerfile
  • golang 1.20-alpine
  • alpine 3.18.0
github-actions
.github/workflows/bearer.yml
.github/workflows/codeql-analysis.yml
  • actions/checkout v3
  • github/codeql-action v2
  • github/codeql-action v2
  • github/codeql-action v2
.github/workflows/debug.yml
.github/workflows/docker.yml
  • actions/checkout v3
  • moul/repoman-action v1
  • actions/checkout v3
  • docker/build-push-action v4.0.0
  • docker/build-push-action v4.0.0
  • docker/build-push-action v4.0.0
.github/workflows/go.yml
  • actions/checkout v3
  • moul/repoman-action v1
  • actions/checkout v3
  • actions/setup-go v4
  • actions/cache v3.3.1
  • goreleaser/goreleaser-action v4.2.0
  • actions/checkout v3
  • actions/setup-go v4
  • golangci/golangci-lint-action v3
  • actions/checkout v3
  • actions/setup-go v4
  • actions/checkout v3
  • actions/setup-go v4
  • actions/cache v3.3.1
  • codecov/codecov-action v3.1.4
  • actions/checkout v3
  • actions/setup-go v4
  • actions/cache v3.3.1
  • codecov/codecov-action v3.1.4
.github/workflows/label-sponsors.yml
  • JasonEtco/is-sponsor-label-action v2.0.0
.github/workflows/pr.yml
  • actions/checkout v3
  • snyk/release-notes-preview v1.6.2
  • actions/checkout v3
.github/workflows/release.yml
  • actions/checkout v3
  • moul/repoman-action v1
  • ghcr.io/codfish/semantic-release-action v2
  • actions/setup-go v4
  • actions/cache v3.3.1
  • goreleaser/goreleaser-action v4.2.0
.github/workflows/semgrep.yml
  • actions/checkout v3
  • ubuntu 20.04
gomod
go.mod
  • go 1.19
  • github.com/peterbourgon/ff/v3 v3.4.0
  • github.com/tailscale/depaware v0.0.0-20210622194025-720c4b409502@720c4b409502
  • go.uber.org/goleak v1.2.1
  • go.uber.org/zap v1.24.0
  • moul.io/climan v1.0.0
  • moul.io/motd v1.0.0
  • moul.io/srand v1.6.1
  • moul.io/u v1.27.0
  • moul.io/zapconfig v1.4.0
npm
package.json
tool/lint/package.json
  • alex 10.0.0
  • markdown-spellcheck 1.3.1
  • markdownlint-cli 0.31.1
  • remark-cli 11.0.0
  • remark-lint 9.1.1

  • Check this box to trigger a request for Renovate to run again on this repository

[META] Ideas πŸ’‘

General

  • cleanup the root of the repo: move dotfiles to subdirs
  • configure nix-shell

Tests

CI/CD

Doc

  • embedmd integration

Integrations

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.