Go dependency publisher

go-dep-writer reads dependencies in go.mod file of a project and writes to a markdown file in the HTML format.

Usage

1. git clone https://github.com/YasiruR/go-dep-writer.git
2. go build
3. ./go-dep-writer -modfile=<go.mod file path>

Parameters

./go-dep-writer [-PARAMS]

• modfile
  • File path of go.mod
• user [optional]
  • Username of the github account. Both user and secret should be provided to utilize github authentication and access API endpoints. If else, API endpoints are accessed without authentication and being constrained under the limitation of a quota.
• secret [optional]
  • Access token to utilize github authentication as described above.
• append [optional]
  • If provided, generated table will be appended to the given file. If not provided, table will be saved to dependencies.md file in the current working directory.
• domains [optional]
  • To save imports with specific domains. Input value should be a list separated by commas. Currently, only github.com, go.uber.org, gopkg.in and golang.org are supported (and all enabled by default).

Sample Output

Dependency	Version	Description
env	v6.9.1	A simple and zero-dependencies library to parse environment variables into structs.
zerolog	v1.22.0	Zero Allocation JSON Logger
aurora	v0.0.0	Golang ultimate ANSI-colors that supports Printf/Sprintf methods
markdown	v0.0.0	markdown parser and HTML renderer for Go