docs: release instructions

tmountain · Jan 6, 2021 · 8be1f6f · 8be1f6f
1 parent 9347fab
commit 8be1f6f
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@
 
 # Build directories
 bin/
+dist/
 
 # Dependency directories (remove the comment below to include it)
 arch/

diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -9,6 +9,7 @@ before:
 builds:
   - env:
       - CGO_ENABLED=0
+    main: ./cmd/uchess/main.go
     goos:
       - linux
       - windows

diff --git a/Makefile b/Makefile
@@ -17,3 +17,6 @@ build: tidy
 
 release:
 	rm -rf dist && goreleaser
+
+release_test:
+	rm -rf dist && goreleaser --snapshot --skip-publish --rm-dist
diff --git a/docs/release.txt b/docs/release.txt
@@ -0,0 +1,12 @@
+Process for a release is as follows:
+
+GoReleaser will use the latest Git tag of your repository. Create a tag and push it to GitHub:
+
+git tag -a v0.1.0 -m "First release"
+git push origin v0.1.0
+
+Then run:
+
+make release
+
+Release notes can be edited on Github.
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,7 @@ @@
     # Build directories
     bin/
+    dist/
     # Dependency directories (remove the comment below to include it)
     arch/
@@ Expand Down @@