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

Added goreleaser changelog groups and update PR template #580

Merged
merged 5 commits into from
Feb 28, 2022
Merged

Added goreleaser changelog groups and update PR template #580

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8eea04e
Added goreleaser changelog groups and update PR template
Feb 28, 2022
5121490
Added deprecation notice to changelog
Feb 28, 2022
d9d73d5
Made naming instructions a comment
Feb 28, 2022
542a63c
Updated dependabot to add to adhere to changelog rules
Feb 28, 2022
25309b2
Changed dependabot frequency to weekly
Feb 28, 2022
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: 8 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
## 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

_Delete the above paragraph before submitting._
Copy link
Contributor

@Mrod1598 Mrod1598 Feb 28, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could also, have the above just be a comment so then it really doesn't matter. What's meant to be in the parenthese?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I'll do that.

Anything you want can go in the parenthesis or just ignore them all together.


## 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
70 changes: 41 additions & 29 deletions .goreleaser.yml
View file
Open in desktop
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
View file
Open in desktop
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