Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tpl/tplimpl: Deprecate .Site.Author usage in RSS template #11569

Merged
merged 1 commit into from
Oct 17, 2023

Conversation

jmooring
Copy link
Member

@jmooring jmooring commented Oct 17, 2023

This is the first step in deprecating the author key in site configuration. Our internal exposure is limited to the RSS template. Site authors will receive a warning, generated by the RSS template, if they are using:

[author]
name = 'John Doe'
email = 'jdoe@example.org'

They will be instructed to change this to:

[params.author]
name = 'John Doe'
email = 'jdoe@example.org'

After this has been running in the field for a while, and site authors have made the change, we can:

  1. Deprecate func (s *Site) Author(), and simultaneously
  2. Remove site.Author.email and site.Author.name from the RSS template

The author key in site configuration is not documented, so, other than its usage in the RSS template, our external exposure should be limited.

@bep bep merged commit d4016dd into gohugoio:master Oct 17, 2023
8 checks passed
@jmooring jmooring deleted the begin-deprecation-of-site-author branch October 17, 2023 18:10
insidemordecai added a commit to insidemordecai/insidemordecai.com that referenced this pull request Aug 29, 2024
UmmItC added a commit to UmmItC/Blog that referenced this pull request Sep 5, 2024
…sh `v2.76.0`

Due to recent updates in Hugo, the `[author]` key is being deprecated. Hugo now provides a warning for the `[author]` key usage in site configuration, and recommends switching to `[params.author]`.

This update in Blowfish ensures compatibility with Hugo's changes and restores the display of the author section.

The Hugo fix addresses some issues with the `[author]` key but still requires the use of `[params.author]` in themes. This update aligns with Hugo’s deprecation process and prepares for future changes where `[author]` may be fully removed.

Blowfish release `v2.76.0`: https://github.com/nunocoracao/blowfish/releases/tag/v2.76.0

For usage details commit of blowfish: nunocoracao/blowfish@a517624

Hugo deprecation details: gohugoio/hugo#11569
UmmItC added a commit to UmmItC/Blog that referenced this pull request Sep 5, 2024
…sh `v2.76.0`

To maintain compatibility with Hugo (v0.124.0) and its deprecation of the `[author]` key, updated Blowfish to use `[params.author]`. This change ensures the author section displays correctly and aligns with Hugo’s new configuration requirements.

Blowfish release `v2.76.0`: https://github.com/nunocoracao/blowfish/releases/tag/v2.76.0

For usage details: nunocoracao/blowfish@a517624

Hugo deprecation details: gohugoio/hugo#11569
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants