-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add changelog contributing and goreleaser to the project
- Loading branch information
Showing
4 changed files
with
129 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: goreleaser | ||
|
||
on: | ||
push: | ||
tags: | ||
- '*' | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
goreleaser: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- | ||
name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- | ||
name: Set up Go | ||
uses: actions/setup-go@v4 | ||
with: | ||
go-version: 1.22 | ||
- | ||
name: Test | ||
run: go test -v ./... | ||
- | ||
name: Run GoReleaser | ||
uses: goreleaser/goreleaser-action@v5 | ||
with: | ||
distribution: goreleaser | ||
version: latest | ||
args: release --clean | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
project_name: dmarcr | ||
env: | ||
- GO111MODULE=on | ||
- GOPROXY=https://proxy.golang.org | ||
before: | ||
hooks: | ||
- go mod download | ||
builds: | ||
- env: | ||
- CGO_ENABLED=0 | ||
flags: | ||
- -buildmode | ||
- exe | ||
goos: | ||
- darwin | ||
- linux | ||
- windows | ||
- freebsd | ||
- netbsd | ||
- openbsd | ||
- dragonfly | ||
goarch: | ||
- amd64 | ||
- 386 | ||
- arm | ||
- arm64 | ||
goarm: | ||
- 7 | ||
- 6 | ||
ignore: | ||
- goos: darwin | ||
goarch: 386 | ||
- goos: windows | ||
goarch: arm64 | ||
|
||
archives: | ||
- | ||
id: "dmarcr" | ||
builds: ['dmarcr'] | ||
format: tar.gz | ||
format_overrides: | ||
- goos: windows | ||
format: zip | ||
checksum: | ||
name_template: 'checksums.txt' | ||
snapshot: | ||
name_template: "{{ .Tag }}-next" | ||
changelog: | ||
sort: asc | ||
filters: | ||
exclude: | ||
- '^docs:' | ||
- '^test:' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# 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). | ||
|
||
## [0.0.1] - 2024-04-03 | ||
|
||
### Added | ||
|
||
- first version was released. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Contributing | ||
|
||
1. Sign one of the contributor license agreements below. | ||
1. [Install Go](https://golang.org/doc/install). | ||
1. Clone the repo: | ||
|
||
`git clone https://github.com/dubyte/dmarcr.git` | ||
|
||
1. Change into the checked out source: | ||
|
||
`cd dmarcr` | ||
|
||
1. Fork the repo. | ||
1. Set your fork as a remote: | ||
|
||
`git remote add fork https://github.com/GITHUB_USERNAME/dmarcr.git` | ||
|
||
1. Make changes and commit | ||
to your fork. Initial commit messages should follow the | ||
[Conventional Commits](https://www.conventionalcommits.org/) style (e.g. | ||
`feat(functions): add gophers codelab`). | ||
1. Send a pull request with your changes. | ||
1. A maintainer will review the pull request and make comments. Prefer adding | ||
additional commits over amending and force-pushing since it can be difficult | ||
to follow code reviews when the commit history changes. | ||
|
||
Commits will be squashed when they're merged. |