hugo-blox-builder icon indicating copy to clipboard operation
hugo-blox-builder copied to clipboard

No tag for reveal plugin

Open thomwiggers opened this issue 1 year ago • 4 comments

There's no tag for modules/woowchemy-plugin-reveal, so I have to use main or a commit; this is counter to what https://wowchemy.com/docs/hugo-tutorials/update/#tldr mentions.

Steps to Reproduce

  1. try out https://wowchemy.com/docs/hugo-tutorials/update/#tldr
  2. prefer to use fixed version numbers because upgrade migrations are only documented for those
  3. there's no version number for wowchemy-plugin-reveal.

thomwiggers avatar Aug 30 '22 12:08 thomwiggers

Concur, because of the way hugo uses the releases as the method to pull the module this is a problem.

My solution was to fork the repo, modify the go.mod file, and then add that repo to my site.

Perhaps when we add a feature like this we can use a proper semver update?

ShoGinn avatar Sep 02 '22 20:09 ShoGinn

Concur, because of the way hugo uses the releases as the method to pull the module this is a problem.

My solution was to fork the repo, modify the go.mod file, and then add that repo to my site.

Perhaps when we add a feature like this we can use a proper semver update?

Note that if your site doesn't use Reveal (slides), you don't need to install the Reveal module in your site.

The Reveal module has not been formally released yet - if you would like to help review it, test it, and write some release notes, feel free. Once contributors have helped with this, we can tag that module and publish some release notes for it.

Go Modules doesn't require that the repo is forked in order to use a specific module version.

With Go Modules, you can use any Git version reference you like. For example, you can lock a module to a specific commit, which could even be a tagged commit from the Releases page. You can learn more about managing Go Modules in the Hugo docs, Go docs, and Wowchemy docs (https://wowchemy.com/docs/hugo-tutorials/update/ ).

gcushen avatar Sep 03 '22 10:09 gcushen

@gcushen so my bad; I did not search your tutorial before google! Finding that you can just have main at the end is not very well documented! Thanks for that

ShoGinn avatar Sep 03 '22 12:09 ShoGinn

Maybe the update instructions could then be amended to specify that reveal is optional.

thomwiggers avatar Sep 05 '22 14:09 thomwiggers