updated release template and pkg docs

brittonhayes · Dec 7, 2020 · e701ce2 · e701ce2
1 parent cc8f9ff
commit e701ce2
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 65 deletions.
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -31,7 +31,7 @@ changelog:
       - '^examples:'
 scoop:
   # Template for the url which is determined by the given Token (github or gitlab)
-  url_template: "http://github.com/brittonhayes/pillager/releases/{{ .Tag }}/{{ .ArtifactName }}"
+  url_template: "https://github.com/brittonhayes/pillager/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
 
   # Repository to push the app manifest to.
   bucket:

diff --git a/cmd/hunt.go b/cmd/hunt.go
@@ -1,25 +1,6 @@
-/*
-Copyright © 2020 Britton Hayes
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-*/
-// Package cmd contains all the commands available in the cli
+// Package cmd contains the command line logic
+//
+// The cmd package is the primary consumer of all packages in the /pkg directory
 package cmd
 
 import (

diff --git a/cmd/root.go b/cmd/root.go
@@ -1,24 +1,3 @@
-/*
-Copyright © 2020 Britton Hayes
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-*/
 package cmd
 
 import (

diff --git a/main.go b/main.go
@@ -1,25 +1,5 @@
-/*
-Copyright © 2020 Britton Hayes
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-*/
 //go:generate gomarkdoc ./pkg/...
+// Package main is the primary entrypoint to the CLI
 package main
 
 import "pillager/cmd"

diff --git a/pkg/hunter/docs.go b/pkg/hunter/docs.go
@@ -0,0 +1,2 @@
+// Package hunter contains the types, methods, and interfaces for the file hunting portion of pillager
+package hunter
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package hunter contains the types, methods, and interfaces for the file hunting portion of pillager
		package hunter