diff --git a/entrypoint/entrypoint.go b/entrypoint/entrypoint.go index df5c6148..8464c2f7 100644 --- a/entrypoint/entrypoint.go +++ b/entrypoint/entrypoint.go @@ -12,6 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package entrypoint provides functionality to run Scorecard. package entrypoint import ( diff --git a/github/github.go b/github/github.go index 464d020f..28590265 100644 --- a/github/github.go +++ b/github/github.go @@ -12,6 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package github provides repo information from GitHub. package github import ( diff --git a/install/cli/cli.go b/install/cli/cli.go index 2bc76553..eacee839 100644 --- a/install/cli/cli.go +++ b/install/cli/cli.go @@ -14,6 +14,7 @@ // // SPDX-License-Identifier: Apache-2.0 +// Package cli contains the root CLI command. package cli import ( diff --git a/install/github/github.go b/install/github/github.go index 32cfc987..7fe30347 100644 --- a/install/github/github.go +++ b/install/github/github.go @@ -14,6 +14,7 @@ // // SPDX-License-Identifier: Apache-2.0 +// Package github interacts with GitHub repos and orgs. package github import ( diff --git a/install/install.go b/install/install.go index 93f311eb..712079a4 100644 --- a/install/install.go +++ b/install/install.go @@ -14,6 +14,7 @@ // // SPDX-License-Identifier: Apache-2.0 +// Package install contains functionality to install the OpenSSF Scorecard workflow. package install import ( diff --git a/install/options/options.go b/install/options/options.go index e402e3ce..e728b337 100644 --- a/install/options/options.go +++ b/install/options/options.go @@ -14,6 +14,7 @@ // // SPDX-License-Identifier: Apache-2.0 +// Package options provides installation options for the scorecard action. package options import ( diff --git a/main.go b/main.go index c15219e5..6aac0161 100644 --- a/main.go +++ b/main.go @@ -12,6 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Command scorecard-action is the entrypoint for the Scorecard GitHub Action. package main import (