fix github action warnings

build/test/server.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package test is for integration testing.
 package test
 
 import (

cmd/client/command/common.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package command implements commands of Easegress client.
 package command
 
 import (

cmd/client/main.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package main is the entry point of Easegress client.
 package main
 
 import (

cmd/server/main.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package main is the entry point of Easegress server.
 package main
 
 import (

example/backend-service/echo/echo.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package main is the entry point of the simple echo server.
 package main
 
 import (

example/backend-service/mirror/mirror.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package main is the entry point of the simple mirror server.
 package main
 
 import (

example/backend-service/remote/remote.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package main is the entry point of the simple Easegress remote server.
 package main
 
 import (

pkg/api/api.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package api implements the HTTP API of Easegress.
 package api
 
 import (

pkg/cluster/cluster.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package cluster provides the cluster management.
 package cluster
 
 import (

pkg/cluster/clustertest/cluster.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package clustertest provides a mocked cluster for testing.
 package clustertest
 
 import (
@@ -124,6 +125,7 @@ func (mc *MockedCluster) Put(key, value string) error {
  return nil
 }
 
+// PutUnderTimeout implements interface function PutUnderTimeout
 func (mc *MockedCluster) PutUnderTimeout(key, value string, timeout time.Duration) error {
  if mc.MockedPutUnderTimeout != nil {
  return mc.MockedPutUnderTimeout(key, value, timeout)

pkg/cluster/customdata/customdata.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package customdata provides a way to store custom data in Easegress cluster.
 package customdata
 
 import (

pkg/common/utils.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package common provides several common utilities for other packages.
 package common
 
 import (

pkg/context/context.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package context provides the context for traffic handlers.
 package context
 
 import (

pkg/context/contexttest/contexttest.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package contexttest provides utilities for testing context.
 package contexttest
 
 import "github.com/megaease/easegress/pkg/context"

pkg/env/env.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package env provides functions for environment variables.
 package env
 
 import (

pkg/filters/builder/builder.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package builder implements builder filters.
 package builder
 
 import (

pkg/filters/certextractor/certextractor.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package certextractor implements a filter to extract given field from TLS.
 package certextractor
 
 import (

pkg/filters/connectcontrol/connectcontrol.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package connectcontrol implements filter for controlling connections of MQTT clients
 package connectcontrol
 
 import (

pkg/filters/corsadaptor/corsadaptor.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package corsadaptor implements a filter that adapts CORS stuff.
 package corsadaptor
 
 import (

pkg/filters/fallback/fallback.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package fallback implements the fallback filter.
 package fallback
 
 import (

pkg/filters/filters.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package filters implements common functionality of filters.
 package filters
 
 import (

pkg/filters/headerlookup/headerlookup.go

@@ -15,6 +15,8 @@
 * limitations under the License.
  */
 
+// Package headerlookup implements a filter that enriches request headers
+// per request, looking up values from etcd.
 package headerlookup
 
 import (

pkg/filters/headertojson/headertojson.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package headertojson implements a filter to convert HTTP request header to json.
 package headertojson
 
 import (

pkg/filters/kafka/kafka.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package kafka implements a kafka proxy for MQTT requests.
 package kafka
 
 import (
@@ -36,7 +37,7 @@ const (
 
 var kind = &filters.Kind{
  Name: Kind,
- Description: "Kafka is a backend of MQTTProxy",
+ Description: "Kafka is a kafka proxy for MQTT requests",
  Results: []string{resultGetDataFailed},
  DefaultSpec: func() filters.Spec {
  return &Spec{}
@@ -51,7 +52,7 @@ func init() {
 }
 
 type (
- // Kafka is kafka backend for MQTT proxy
+ // Kafka is a kafka proxy for MQTT requests.
  Kafka struct {
  spec *Spec
  producer sarama.AsyncProducer

pkg/filters/kafka/kafka_test.go

@@ -63,11 +63,11 @@ func (m *mockAsyncProducer) AbortTxn() error {
  return nil
 }
 
-func (m *mockAsyncProducer) AddOffsetsToTxn(offsets map[string][]*sarama.PartitionOffsetMetadata, groupId string) error {
+func (m *mockAsyncProducer) AddOffsetsToTxn(offsets map[string][]*sarama.PartitionOffsetMetadata, groupID string) error {
  return nil
 }
 
-func (m *mockAsyncProducer) AddMessageToTxn(msg *sarama.ConsumerMessage, groupId string, metadata *string) error {
+func (m *mockAsyncProducer) AddMessageToTxn(msg *sarama.ConsumerMessage, groupID string, metadata *string) error {
  return nil
 }
 

pkg/filters/kafkabackend/kafka.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package kafka implements a kafka proxy for HTTP requests.
 package kafka
 
 import (
@@ -38,7 +39,7 @@ const (
 
 var kind = &filters.Kind{
  Name: Kind,
- Description: "Kafka is a backend of MQTTProxy",
+ Description: "Kafka is a kafka proxy for HTTP requests",
  Results: []string{resultParseErr},
  DefaultSpec: func() filters.Spec {
  return &Spec{}
@@ -53,7 +54,7 @@ func init() {
 }
 
 type (
- // Kafka is kafka backend for MQTT proxy
+ // Kafka is a kafka proxy for HTTP requests.
  Kafka struct {
  spec *Spec
  producer sarama.AsyncProducer

pkg/filters/kafkabackend/kafka_test.go

@@ -59,11 +59,11 @@ func (m *mockAsyncProducer) AbortTxn() error {
  return nil
 }
 
-func (m *mockAsyncProducer) AddOffsetsToTxn(offsets map[string][]*sarama.PartitionOffsetMetadata, groupId string) error {
+func (m *mockAsyncProducer) AddOffsetsToTxn(offsets map[string][]*sarama.PartitionOffsetMetadata, groupID string) error {
  return nil
 }
 
-func (m *mockAsyncProducer) AddMessageToTxn(msg *sarama.ConsumerMessage, groupId string, metadata *string) error {
+func (m *mockAsyncProducer) AddMessageToTxn(msg *sarama.ConsumerMessage, groupID string, metadata *string) error {
  return nil
 }
 

pkg/filters/meshadaptor/meshadaptor.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package meshadaptor provides MeshAdaptor filter.
 package meshadaptor
 
 import (

pkg/filters/mock/mock.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package mock provides Mock filter.
 package mock
 
 import (

pkg/filters/mqttclientauth/mqttauth.go

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+// Package mqttclientauth implements authentication for MQTT clients.
 package mqttclientauth
 
 import (