Skip to content

Commit

Permalink
Added goreleaser changelog groups and update PR template (#580)
Browse files Browse the repository at this point in the history
* Added goreleaser changelog groups and update PR template

Signed-off-by: Corbin Phelps <corbin.phelps@bluemedora.com>

* Added deprecation notice to changelog

Signed-off-by: Corbin Phelps <corbin.phelps@bluemedora.com>

* Made naming instructions a comment

Signed-off-by: Corbin Phelps <corbin.phelps@bluemedora.com>

* Updated dependabot to add to adhere to changelog rules

Signed-off-by: Corbin Phelps <corbin.phelps@bluemedora.com>

* Changed dependabot frequency to weekly

Signed-off-by: Corbin Phelps <corbin.phelps@bluemedora.com>
  • Loading branch information
Corbin Phelps authored Feb 28, 2022
1 parent 5080693 commit 6410e79
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 37 deletions.
8 changes: 7 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
<!--Important (read before submitting)
In order for changes to be captured in changelog correctly please add one of the following prefixes to the title. **Note** the parenthesis are optional and so is any text in them.
- `feat(OPTIONAL):` = New features
- `fix(OPTIONAL):` = Bug fixes
- `deps(OPTIONAL):` = Dependency updates, primarily dependabot
-->

## Description of Changes

## **Please check that the PR fulfills these requirements**
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] Add a changelog entry (for non-trivial bug fixes / features)
- [ ] CI passes
10 changes: 8 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@ updates:
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "monthly"
interval: "weekly"
commit-message:
prefix: "deps"
include: "scope"
- package-ecosystem: "gomod"
directory: "/internal/tools"
schedule:
interval: "monthly"
interval: "weekly"
commit-message:
prefix: "deps"
include: "scope"
70 changes: 41 additions & 29 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
builds:
- id: stanza
binary: stanza_{{ .Os }}_{{ .Arch }}
main: ./cmd/stanza
env:
- CGO_ENABLED=0
flags:
-tags=timetzdata
mod_timestamp: '{{ .CommitTimestamp }}'
goos:
- windows
- linux
- darwin
goarch:
- amd64
- arm64
ignore:
- goos: windows
goarch: arm64
ldflags:
- -X github.com/observiq/stanza/version.GitTag={{ .Tag }}
- -X github.com/observiq/stanza/version.GitCommit={{ .FullCommit }}
no_unique_dist_dir: true
hooks:
post: ./build/post.sh
- id: stanza
binary: stanza_{{ .Os }}_{{ .Arch }}
main: ./cmd/stanza
env:
- CGO_ENABLED=0
flags: -tags=timetzdata
mod_timestamp: "{{ .CommitTimestamp }}"
goos:
- windows
- linux
- darwin
goarch:
- amd64
- arm64
ignore:
- goos: windows
goarch: arm64
ldflags:
- -X github.com/observiq/stanza/version.GitTag={{ .Tag }}
- -X github.com/observiq/stanza/version.GitCommit={{ .FullCommit }}
no_unique_dist_dir: true
hooks:
post: ./build/post.sh

archives:
- builds:
- stanza
# skip archiving as tar.gz / zip
format: binary
- builds:
- stanza
# skip archiving as tar.gz / zip
format: binary

checksum:
name_template: '{{ .ProjectName }}-v{{ .Version }}-SHA256SUMS'
name_template: "{{ .ProjectName }}-v{{ .Version }}-SHA256SUMS"
algorithm: sha256

release:
Expand All @@ -42,5 +41,18 @@ release:
changelog:
skip: false
use: github
sort: asc
groups:
- title: "New Features"
regexp: "^.*feat[(\\w)]*:+.*$"
order: 0
- title: "Bug Fixes"
regexp: "^.*fix[(\\w)]*:+.*$"
order: 10
- title: "Dependencies"
regexp: "^.*deps[(\\w)]*:+.*$"
order: 30
- title: Other
order: 999

dist: artifacts
8 changes: 3 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# Deprecation
Changelog is deprecated in favor of using gorelaser changelog. Keeping the changelog around for history sake.

# 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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

### Added

### Changed
## 1.6.0

### Added
Expand Down

0 comments on commit 6410e79

Please sign in to comment.