Require Hugo 0.120+, fix deprecation warnings #502

hydr0nium · 2024-07-10T00:06:36Z

I changed the parameter .site.IsServer parameter to hugo.isServer because the first one is deprecated.

henryiii · 2024-07-10T04:29:22Z

Any idea of how far back the new one works?

henryiii · 2024-07-10T04:31:13Z

New in 0.120 https://gohugo.io/functions/hugo/isserver/

Did they have to deprecate the same version they added the replacement?

henryiii · 2024-07-10T04:34:27Z

Eh, we are on 0.128 now, so I'd be okay with making 0.120 the minimum, I think. Anyone else?

hydr0nium · 2024-07-10T10:18:46Z

@henryiii

I would say that being basically 8 versions ahead of the deprecated function is enough.

I also found another deprecated feature .Site.DisqusShortname which also got deprecated since 0.120. If we change to ~~0.128~~ 0.120 we can also update that as well.

In the face of that we will update to 0.120 it would also be nice to update the README to reference the hugo.* file as the config instead of the config.* file. I also changed the description of the disqus feature to match the updated version of the code

henryiii · 2024-07-10T13:59:09Z

Can we make it a hard error (errorf) if too old?

hydr0nium · 2024-07-10T14:06:55Z

Could we use the min_version parameter in the theme.toml and HUGO_VERSION in netlify.toml file?

hydr0nium · 2024-07-10T14:16:34Z

Other than that we could maybe use the errorf and the hugo.Version function to check if a specific version is used. Just don't know where we would put it

henryiii · 2024-07-10T14:28:08Z

The theme.toml one sounds good. I assume Hugo would error with a nice message if that was too high.

henryiii · 2024-07-10T14:30:02Z

layouts/partials/disqus.html

@@ -1,7 +1,7 @@
 {{ if (.Params.comments) | or (and (or (not (isset .Params "comments")) (eq .Params.comments nil)) (.Site.Params.comments)) }}
-  {{ if .Site.DisqusShortname }}
+  {{ if .Site.Config.Services.Disqus.Shortname }}


Should we error if Site.DisqusShortname is set? Similar to what I added in #481? Otherwise no one will know this was changed, it will just vanish from sites.

Yeah I guess you can add that. Sounds good.

Edit: I can also add it if you have not time for that

If you'd like to, go ahead. Pretty distracted at the moment with catch up in various projects.

Ok you can not access the disqusShortname as you did with author due to the fact that it is a default value in .Site and will always be set by default to the empty string. As far as I see it there is not a proper way of checking if people use this deprecated feature without getting a warning because we need to use .Site.disqusShortname to actually check if people use it. I would say a compromise is that we do a check in a central location using .Site.disqusShortname with a warning that after sometime this check will be removed as .Site.disqusShortname is deprecated.

My idea is to use this in the baseof.html

{{ if le hugo.Version "0.120.0" }} {{ errorf "Please use Hugo version 0.120.0 or higher!"}} {{ end }} {{ if not (eq .Site.DisqusShortname "") }} {{ errorf "Your use of disqusShortname is deprecated by Hugo; Please reference the README.md for further instructions. This error message will be removed in the future because we are also using .Site.DisqusShortname for checking this."}} {{ end }}

Seems reasonable. I can move the other check (Site.Author) there too after it's in.

hydr0nium · 2024-07-10T15:08:17Z

The theme.toml one sounds good. I assume Hugo would error with a nice message if that was too high.

I did some tests and changing theme.toml would result in telling the user that they are using the wrong version. The problem is though that it does not stop the build.

Maybe adding another check in something like the baseof.html with the hugo.Version and errorf would be a second measure to stop the build.

henryiii · 2024-07-11T15:54:27Z

Would you mind rebasing or merging to resolve conflicts? Then I'll trigger the CI.

henryiii · 2024-07-11T16:06:20Z

layouts/_default/baseof.html

+
+{{ if not (eq .Site.DisqusShortname "") }}
+	{{ errorf "Your use of disqusShortname is deprecated by Hugo; Please reference the README.md for further instructions.
+	This error message will be removed in the future because we are also using .Site.DisqusShortname for checking this."}}


Are multiple lines allowed?

ERROR "/home/runner/work/beautifulhugo/beautifulhugo/layouts/_default/baseof.html:6:1": parse failed: template: _default/single.html:6: unterminated quoted string

I think the problem is somewhere in the single.html, but I can't find where.

I will take a look soon

It says line 6 of baseof.html, which is exactly this multiline string.

Maybe you need tick-marks instead? gohugoio/hugoDocs#764

Should be fixed now

…fulhugo into deprecated_code

henryiii · 2024-07-11T16:36:49Z

README.md

+[services]
+  [services.disqus]
+    shortname = ''


Suggested change

[services]

[services.disqus]

shortname = ''

[services.disqus]

shortname = ''

Probably matches everything else, so not changing it here, but I really don't like this fake TOML nesting. Pretending TOML cares about indentation when it doesn't isn't helpful, IMO.

henryiii · 2024-07-11T16:37:29Z

Thanks for pushing this through!

* Fixed deprecated site.isServer param to hugo.isServer param * Also fixed another deprecated function for disqus * Updated README.md In the face of that we will update to 0.120 it would also be nice to update the README to reference the hugo.* file as the config instead of the config.* file. I also changed the description of the disqus feature to match the updated version of the code * Added checks for hugoVersion and disqus feature * Fixed accidental delete * Removed new line

Fixed deprecated site.isServer param to hugo.isServer param

913c331

hydr0nium mentioned this pull request Jul 10, 2024

.Site.IsServer was deprecated #501

Closed

Also fixed another deprecated function for disqus

88ed6c7

hydr0nium changed the title ~~Fixed deprecated .site.IsServer parameter~~ Fixed deprecated .functions Jul 10, 2024

hydr0nium changed the title ~~Fixed deprecated .functions~~ Fixed deprecated functions Jul 10, 2024

Updated README.md

46efded

In the face of that we will update to 0.120 it would also be nice to update the README to reference the hugo.* file as the config instead of the config.* file. I also changed the description of the disqus feature to match the updated version of the code

henryiii reviewed Jul 10, 2024

View reviewed changes

Added checks for hugoVersion and disqus feature

8ed9be3

hydr0nium added 2 commits July 11, 2024 17:57

Fixed accidental delete

d7f910a

Merge branch 'master' into deprecated_code

501eb28

henryiii reviewed Jul 11, 2024

View reviewed changes

hydr0nium added 2 commits July 11, 2024 18:27

Removed new line

6ac1940

Merge branch 'deprecated_code' of https://github.com/hydr0nium/beauti…

5e720ad

…fulhugo into deprecated_code

henryiii changed the title ~~Fixed deprecated functions~~ Require Hugo 0.120+, fix deprecation warnings Jul 11, 2024

henryiii reviewed Jul 11, 2024

View reviewed changes

henryiii approved these changes Jul 11, 2024

View reviewed changes

henryiii merged commit 484d57f into halogenica:master Jul 11, 2024
1 check passed

hydr0nium deleted the deprecated_code branch July 11, 2024 17:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Require Hugo 0.120+, fix deprecation warnings #502

Require Hugo 0.120+, fix deprecation warnings #502

hydr0nium commented Jul 10, 2024

henryiii commented Jul 10, 2024

henryiii commented Jul 10, 2024

henryiii commented Jul 10, 2024

hydr0nium commented Jul 10, 2024 •

edited

Loading

henryiii commented Jul 10, 2024

hydr0nium commented Jul 10, 2024 •

edited

Loading

hydr0nium commented Jul 10, 2024

henryiii commented Jul 10, 2024

henryiii Jul 10, 2024

hydr0nium Jul 10, 2024 •

edited

Loading

henryiii Jul 10, 2024

hydr0nium Jul 11, 2024 •

edited

Loading

hydr0nium Jul 11, 2024

henryiii Jul 11, 2024

hydr0nium commented Jul 10, 2024 •

edited

Loading

henryiii commented Jul 11, 2024

henryiii Jul 11, 2024

hydr0nium Jul 11, 2024

hydr0nium Jul 11, 2024

henryiii Jul 11, 2024

henryiii Jul 11, 2024

hydr0nium Jul 11, 2024

henryiii Jul 11, 2024

henryiii commented Jul 11, 2024

Require Hugo 0.120+, fix deprecation warnings #502

Require Hugo 0.120+, fix deprecation warnings #502

Conversation

hydr0nium commented Jul 10, 2024

henryiii commented Jul 10, 2024

henryiii commented Jul 10, 2024

henryiii commented Jul 10, 2024

hydr0nium commented Jul 10, 2024 • edited Loading

henryiii commented Jul 10, 2024

hydr0nium commented Jul 10, 2024 • edited Loading

hydr0nium commented Jul 10, 2024

henryiii commented Jul 10, 2024

Choose a reason for hiding this comment

hydr0nium Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hydr0nium Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hydr0nium commented Jul 10, 2024 • edited Loading

henryiii commented Jul 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

henryiii commented Jul 11, 2024

hydr0nium commented Jul 10, 2024 •

edited

Loading

hydr0nium commented Jul 10, 2024 •

edited

Loading

hydr0nium Jul 10, 2024 •

edited

Loading

hydr0nium Jul 11, 2024 •

edited

Loading

hydr0nium commented Jul 10, 2024 •

edited

Loading