Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Changelog #131

Merged
merged 18 commits into from
Apr 30, 2021
Merged

Add Changelog #131

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
1a8a2ce
Create CHANGELOG.md
pellared Apr 30, 2021
e6078da
Update README.md
pellared Apr 30, 2021
49dbe38
Update CHANGELOG.md
pellared Apr 30, 2021
1b41835
Update CHANGELOG.md
pellared Apr 30, 2021
c3ca0e1
Update README.md
pellared Apr 30, 2021
eccabe9
Update CHANGELOG.md
pellared Apr 30, 2021
9abed4c
Update CHANGELOG.md
pellared Apr 30, 2021
7457ae2
Update CHANGELOG.md
pellared Apr 30, 2021
63b86ee
Update CHANGELOG.md
pellared Apr 30, 2021
67c2418
Update README.md
pellared Apr 30, 2021
5c9bfc6
Update README.md
pellared Apr 30, 2021
01a696b
Update README.md
pellared Apr 30, 2021
df0ec95
Update CHANGELOG.md
pellared Apr 30, 2021
3624d51
Update CHANGELOG.md
pellared Apr 30, 2021
03d6b68
Update CHANGELOG.md
pellared Apr 30, 2021
6bd0cc2
Apply suggestions from code review
pellared Apr 30, 2021
bd9535e
Update CHANGELOG.md
pellared Apr 30, 2021
43ebe46
Update README.md
pellared Apr 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https:/golang-templates/seed/compare/v0.14.0...HEAD)

### Added

- Add [CHANGELOG.md](CHANGELOG.md) based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ([#131](https:/golang-templates/seed/pull/131))

### Changed

- Refine the triggers for the `build` GitHub workflow. ([#130](https:/golang-templates/seed/pull/130))
- Automatic trigger for the `main` branch.
- Automatic trigger for pull requests targeting the `main` branch.
- Manual trigger via [`workflow_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) ([blog post](https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/)).
- Lock the runners' versions in `build` and `release` GitHub workflows. ([#130](https:/golang-templates/seed/pull/130))
pellared marked this conversation as resolved.
Show resolved Hide resolved
pellared marked this conversation as resolved.
Show resolved Hide resolved

## [0.14.0](https:/golang-templates/seed/releases/tag/v0.14.0)

### Added

- Build and push a Docker container image. ([#127](https:/golang-templates/seed/pull/127))

### Changed

- Move `main` package to the root directory. ([#127](https:/golang-templates/seed/pull/127))
pellared marked this conversation as resolved.
Show resolved Hide resolved
- It is suggested to use the `cmd` structure if the repository builds more than one application.
- Update [.golangci.yml](https:/golang-templates/seed/blob/main/.golangci.yml). ([#127](https:/golang-templates/seed/pull/127))
pellared marked this conversation as resolved.
Show resolved Hide resolved
- Bump [GoReleaser](github.com/goreleaser/goreleaser) to [0.162.0](https:/goreleaser/goreleaser/releases/tag/v0.162.0). ([#126](https:/golang-templates/seed/pull/126))
pellared marked this conversation as resolved.
Show resolved Hide resolved
- Bump [golangci-lint](github.com/golangci/golangci-lint) to [1.39.0](https:/golangci/golangci-lint/releases/tag/v1.39.0). ([#125](https:/golang-templates/seed/pull/125))
pellared marked this conversation as resolved.
Show resolved Hide resolved
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Go Repository Template

[![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md)
agabrys marked this conversation as resolved.
Show resolved Hide resolved
[![GitHub Release](https://img.shields.io/github/v/release/golang-templates/seed)](https:/golang-templates/seed/releases)
[![Go Reference](https://pkg.go.dev/badge/github.com/golang-templates/seed.svg)](https://pkg.go.dev/github.com/golang-templates/seed)
[![go.mod](https://img.shields.io/github/go-mod/go-version/golang-templates/seed)](go.mod)
Expand Down Expand Up @@ -36,7 +37,10 @@ It includes:
1. Click the `Use this template` button (alt. clone or download this repository).
1. Replace all occurences of `golang-templates/seed` to `your_org/repo_name` in all files.
1. Replace all occurences of `seed` to `repo_name` in [Dockerfile](Dockerfile).
1. Update [LICENSE](LICENSE) and [README.md](README.md).
1. Update the following files:
- [CHANGELOG.md](CHANGELOG.md)
- [LICENSE](LICENSE)
- [README.md](README.md)

## Setup

Expand Down Expand Up @@ -70,11 +74,11 @@ The Development Container configuration mixes [Docker in Docker](https://github.
### Terminal

- `make` - execute the build pipeline.
- `make help` - print help for provided [Make targets](Makefile).
- `make help` - print help for the [Make targets](Makefile).

### Visual Studio Code

`Terminal` → `Run Build Task... (Ctrl+Shift+B or ⇧⌘B)` to execute the build pipeline.
`F1` → `Tasks: Run Build Task (Ctrl+Shift+B or ⇧⌘B)` to execute the build pipeline.

## Release

Expand Down Expand Up @@ -112,13 +116,11 @@ You can always remove the [.devcontainer](.devcontainer) and [.vscode](.vscode)
GitHub Actions is out-of-the-box if you are already using GitHub.
[Here](https:/mvdan/github-actions-golang) you can learn how to use it for Go.

However, changing to any other CI server should be very simple, because this repository has build logic and tooling installation in Makefile.

You can also use the `docker` make target to run the build using a docker container.
However, changing to any other CI server should be very simple, because this repository has build logic and tooling installation in [Makefile](Makefile).

### How can I build on Windows

Install [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) and copy `C:\TDM-GCC-64\bin\mingw32-make.exe` to `C:\TDM-GCC-64\bin\make.exe`.
Install [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) (or [mingw-w64](http://mingw-w64.org/doku.php)) and copy `C:\TDM-GCC-64\bin\mingw32-make.exe` to `C:\TDM-GCC-64\bin\make.exe`.
pellared marked this conversation as resolved.
Show resolved Hide resolved

Alternatively use [WSL (Windows Subsystem for Linux)](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or develop inside a [Remote Container](https://code.visualstudio.com/docs/remote/containers). However, take into consideration that then you are not going to use "bare-metal" Windows.

Expand Down