hugo-mods: release-notify

⚠️ Work in progress! Use at own risk.

Notifies the user whenever a new module release is available.

Use cases

• Notify user whenever a new major/minor/bugfix update is available (configurable)
• Parse and compare semantic versions
• Fetch and display release information

Preconditions:

• Use Hugo module system
• Release via GitHub releases and use semantic versioning
• The go.mod dependencies must come directly from github.com

How does it work? In short: Parses go.mod file, fetches releases via GitHub API and compares local vs. upstream version. Yes, this is all possible by using Hugo natively.

Go get it

Initialize Hugo's mod system on your site:

hugo mod init github.com/<username>/<your-repo>

Add module to site's config (e.g. config.yaml):

module:
  imports:
  - path: github.com/hugo-mods/release-notify

Configuration

Take a look at the exampleSite for now.