Upgrading to v5.6.0 and failed to resolve output format workaround

[tvercaut]

Hi,

I am trying to upgrade to v5.6.0 but am encountering the following error message:
Error: from config: failed to resolve output format "headers" from site config

I have tried the workaround suggested in the docs but this isn't sufficient. It's uning with the following in config/_default/config.yaml

outputs:
  home: [HTML, RSS, JSON, WebAppManifest]
  section: [HTML, RSS]

but reverting to the suggested code

outputs:
  home: [HTML, RSS, JSON, WebAppManifest, headers, redirects]
  section: [HTML, RSS]

still fails.

For the record runing with the version just before the module refactoring works for me with in go.mod

require github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5 v5.0.0-20220627140744-565e5a40ae8b // pre v5.6.0 refactor

and in config.yaml

module:
  imports:
    - path: github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5

When trying to update to v5.6.0, looking at https://wowchemy.com/docs/hugo-tutorials/update/, I am using in go.mod

require github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5 v5.6.0

and in config.yaml

module:
  imports:
    - path: github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5

Am I missing a step in the update process?

[rodrigoalcarazdelaosa]

https://wowchemy.com/docs/hugo-tutorials/troubleshooting/#error-failed-to-resolve-output-format

[tvercaut]

Thanks. I tried this already but it wasn't sufficient in this instance.

[tvercaut]

Not sure why this is the case but it seems related to netlify. I am not using netlify and had thus removed the requirements on the wowchemy-plugin-netlify and wowchemy-plugin-netlify modules. Adding wowchemy-plugin-netlify back allows to bypass the error but I am wondering if this is the proper way of handling this or if this is related to a bug in the module refactoring.

Anyway, I now currently have this in go.mod:

require (
	github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-netlify v1.0.0
	github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5 v5.6.0
)

and this in config.yaml:

module:
  imports:
    - path: github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-netlify
    - path: github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5
[...]
outputs:
  home: [HTML, RSS, JSON, WebAppManifest, headers, redirects]
  section: [HTML, RSS]

[rodrigoalcarazdelaosa]

If you're not using Netlify I suggest you add disable: true like this:

- path: github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-netlify
  disable: true

[tvercaut]

Thanks. I just tried it but with this disable: true, I still end up with the error message:

Error: from config: failed to resolve output format "headers" from site config

[gcushen]

Consider upvoting this Hugo issue to improve the user experience in this scenario: gohugoio/hugo#10208

@tvercaut @rodrigoalcarazdelaosa

[gcushen]

Currently, Hugo does not automatically remove the module's associated output from outputs when you unload a module.

So in this case, if you are not using the module for Netlify headers and redirects, those outputs must be manually removed from your outputs config or Hugo will error that you are trying to output something from a module that isn't loaded.

[tvercaut]

Many thanks. I hadn't realised that headers and redirects refered specifically to the wowchemy-plugin-netlify module. Reading the docs on this makes sense to me now:
https://github.com/wowchemy/wowchemy-hugo-themes/tree/main/modules/wowchemy-plugin-netlify

So removing these from outputs: home: is the right thing to do in my case.