posener/goreadme

Updates readme from Go doc

View on GitHub

Trust Signals

Scorecard Score
Scorecard 2–4scored Jul 6, 2026
Maintenance Recency
Stalelast commit Oct 18, 2024
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: posener/goreadme@4f46da46c138d7a18283dfe718b4ad91da0d63de # v1.4.2

tags can be moved; commit SHAs can't. why a SHA?

Inputs

namedescriptionrequireddefault
readme-fileName of readme file.noREADME.md
debugPrint Goreadme debug output. Set to any non empty value for true.no—
emailEmail for commit message.noposener@gmail.com
github-tokenGithub token for PR comments. Optional.no—
README_FILEAn optional alias which can be used instead of 'readme-file'.no—
GITHUB_TOKENAn optional alias which can be used instead of 'github-token'.no—
import-pathOverride package import path.no—
titleOverride readme title. Default is package name.no—
godoc-urlGo Doc URL for GoDoc badge.nohttps://pkg.go.dev
recursiveLoad docs recursively.nofalse
render-type-contentIf 'types' is specified, render full type content.nofalse
constantsWrite package constants section, and if 'types' is specified, also write per-type constants section.nofalse
variablesWrite package variables section, and if 'types' is specified, also write per-type variables section.nofalse
functionsWrite functions section.nofalse
typesWrite types section.nofalse
factoriesIf 'types' is specified, write section for functions returning each type.nofalse
methodsIf 'types' is specified, write section for methods for each type.nofalse
skip-examplesSkip the examples section.nofalse
skip-sub-packagesSkip the sub packages section.nofalse
badge-travisciShow TravisCI badge.nofalse
badge-codecovShow CodeCov badge.nofalse
badge-golangciShow GolangCI badge.nofalse
badge-godocShow GoDoc badge.nofalse
badge-goreportcardShow GoReportCard badge.nofalse
generated-noticeAdd generated file notice (visible only in Markdown code).nofalse
creditAdd credit line.notrue

Outputs

no outputs