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.

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

init: licencing and basic cleanup #3

Merged
merged 5 commits into from
May 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 1 addition & 8 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,7 @@ jobs:
go-version: '1.22'

- run: make inst

- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}


- run: goreleaser release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
9 changes: 4 additions & 5 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ linters-settings:
gocyclo:
min-complexity: 15
goimports:
local-prefixes: github.com/golang-templates/seed
govet:
shadow: true
local-prefixes: github.com/FMotalleb/crontab-go
govet: {}
misspell:
locale: US
nolintlint:
Expand All @@ -26,7 +25,7 @@ linters:
- errcheck
- exportloopref
- funlen
- gochecknoinits
# - gochecknoinits
- gocritic
- goconst
- gocyclo
Expand All @@ -53,5 +52,5 @@ linters:
- whitespace

issues:
# enable issues excluded by default
# enable issues excluded by default
exclude-use-default: false
15 changes: 1 addition & 14 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,7 @@ archives:
- format_overrides:
- goos: windows
format: zip
dockers:
- image_templates:
- "ghcr.io/golang-templates/seed:latest"
- "ghcr.io/golang-templates/seed:{{ .Major }}"
- "ghcr.io/golang-templates/seed:{{ .Major }}.{{ .Minor }}"
- "ghcr.io/golang-templates/seed:{{ .Major }}.{{ .Minor }}.{{ .Patch }}"
build_flag_templates:
- "--pull"
# OCI annotations: https://github.com/opencontainers/image-spec/blob/main/annotations.md
- "--label=org.opencontainers.image.created={{.Date}}"
- "--label=org.opencontainers.image.name={{.ProjectName}}"
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
- "--label=org.opencontainers.image.version={{.Version}}"
- "--label=org.opencontainers.image.source={{.GitURL}}"

release:
github:
name_template: "{{.Version}}"
Expand Down
8 changes: 4 additions & 4 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
"[go]": {
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": true,
"source.organizeImports": "explicit"
},
},
"[go.mod]": {
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": true,
"source.organizeImports": "explicit"
},
},
// gopls
"go.useLanguageServer": true,
"gopls": {
"formatting.local": "github.com/golang-templates/seed",
"formatting.local": "github.com/FMotalleb/crontab-go",
"formatting.gofumpt": true
},
// golangci-lint
Expand All @@ -27,4 +27,4 @@
"source.organizeImports": "explicit"
}
}
}
}
124 changes: 0 additions & 124 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,124 +0,0 @@
# 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://github.com/golang-templates/seed/compare/v0.19.0...HEAD)

## [0.19.0](https://github.com/golang-templates/seed/releases/tag/v0.19.0)

### Added

- Add `sqlclosecheck` linter. ([#235](https://github.com/golang-templates/seed/pull/235))

### Changed

- Change license to CC0-1.0. ([#241](https://github.com/golang-templates/seed/pull/241))
- Update Codecov instructions for v4. ([#289](https://github.com/golang-templates/seed/pull/289))

### Fixed

- Fix `inst` Make target for Go 1.21. ([#269](https://github.com/golang-templates/seed/pull/269))

## [0.18.0](https://github.com/golang-templates/seed/releases/tag/v0.18.0)

### Changed

- Remove [gomnd](https://github.com/tommy-muehle/go-mnd) linter. ([#230](https://github.com/golang-templates/seed/pull/230))

### Fixed

- Adjust Build Status badge to new shields.io API. ([#231](https://github.com/golang-templates/seed/pull/231))

## [0.17.1](https://github.com/golang-templates/seed/releases/tag/v0.17.1)

### Fixed

- Fix release GitHub workflow. ([#225](https://github.com/golang-templates/seed/pull/225))

## [0.17.0](https://github.com/golang-templates/seed/releases/tag/v0.17.0)

### Changed

- Update golangci-lint configuration. ([#222](https://github.com/golang-templates/seed/pull/222))
- Update Make targets. ([#224](https://github.com/golang-templates/seed/pull/224))

### Removed

- Remove [go-acc](https://github.com/ory/go-acc) and use `coverpkg` flag instead. ([#221](https://github.com/golang-templates/seed/pull/221))

## [0.16.1](https://github.com/golang-templates/seed/releases/tag/v0.16.1)

### Fixed

- Improve GH workflows and Makefile. ([#217](https://github.com/golang-templates/seed/pull/217))

## [0.16.0](https://github.com/golang-templates/seed/releases/tag/v0.16.0)

### Added

- Use [go-acc](https://github.com/ory/go-acc). ([#208](https://github.com/golang-templates/seed/pull/208))
- Add [misspell](https://github.com/client9/misspell). ([#211](https://github.com/golang-templates/seed/pull/211))
- Document docker vs Git Bash workaround. ([#212](https://github.com/golang-templates/seed/pull/212))

### Changed

- Update golangci-lint configuration. ([#196](https://github.com/golang-templates/seed/pull/196))
- Update Visual Studio code configuration. ([#197](https://github.com/golang-templates/seed/pull/197))
- Migrate to ghcr.io. ([#203](https://github.com/golang-templates/seed/pull/203))
- Use SemVer version as release name. ([#206](https://github.com/golang-templates/seed/pull/206))
- Manual changelog. ([#207](https://github.com/golang-templates/seed/pull/207))
- Update Makefile. ([#210](https://github.com/golang-templates/seed/pull/210))
- Bump dependencies.

### Removed

- Remove VS Code Remote Container support. ([#199](https://github.com/golang-templates/seed/pull/199))
- Remove info about GoDownloader as it is deprecated. ([#202](https://github.com/golang-templates/seed/pull/202))
- Remove testify. ([#209](https://github.com/golang-templates/seed/pull/209))

### Fixed

- Add `workflow_dispatch` to all workflows. ([#204](https://github.com/golang-templates/seed/pull/204))
- Fix docker image name. ([#205](https://github.com/golang-templates/seed/pull/205))
- Fix CodeQL GH workflow permissions. ([#216](https://github.com/golang-templates/seed/pull/216))

## [0.15.0](https://github.com/golang-templates/seed/releases/tag/v0.15.0)

### Added

- Add [CHANGELOG.md](CHANGELOG.md) based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ([#131](https://github.com/golang-templates/seed/pull/131))
- Add [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) based on [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). ([#133](https://github.com/golang-templates/seed/pull/133))

### Changed

- Refine the triggers for the `build` GitHub workflow. ([#130](https://github.com/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' version the in `build` and `release` GitHub workflows. ([#130](https://github.com/golang-templates/seed/pull/130))
- Configure `golint` linter with `min-confidence: 0.8` to avoid [false positive "should have a package comment"](https://github.com/golangci/golangci-lint/issues/1556). ([#132](https://github.com/golang-templates/seed/pull/132))
- Configure `gocyclo` linter with `min-complexity: 15` with is a recommended value by [Go Report Card](https://goreportcard.com/). ([#132](https://github.com/golang-templates/seed/pull/132))
- Update [GoReleaser](https://github.com/goreleaser/goreleaser) to [0.164.0](https://github.com/goreleaser/goreleaser/releases/tag/v0.164.0). ([#129](https://github.com/golang-templates/seed/pull/129))

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

### Added

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

### Changed

- Move the `main` package to the root directory. ([#127](https://github.com/golang-templates/seed/pull/127))
- It is suggested to use the `cmd` structure if the repository builds more than one application.
- Update [.golangci.yml](https://github.com/golang-templates/seed/blob/v0.14.0/.golangci.yml). ([#127](https://github.com/golang-templates/seed/pull/127))
- Update [GoReleaser](https://github.com/goreleaser/goreleaser) to [0.162.0](https://github.com/goreleaser/goreleaser/releases/tag/v0.162.0). ([#126](https://github.com/golang-templates/seed/pull/126))
- Update [golangci-lint](https://github.com/golangci/golangci-lint) to [1.39.0](https://github.com/golangci/golangci-lint/releases/tag/v1.39.0). ([#125](https://github.com/golang-templates/seed/pull/125))

<!-- markdownlint-configure-file
MD024:
# Only check sibling headings
siblings_only: true
-->
Loading
Loading