mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 23:38:53 +00:00
Update deprecation notes
This commit is contained in:
Joe Mooring
@@ -400,13 +400,13 @@ Use [`hugo.IsServer`] instead.
|
||||
{{%/* /deprecated-in */%}}
|
||||
{{< /code >}}
|
||||
|
||||
When deprecating a function or method, add this to front matter:
|
||||
When deprecating a function or method, add something like this to front matter:
|
||||
|
||||
{{< code-toggle file=content/something/foo.md fm=true >}}
|
||||
expiryDate: 2024-10-30
|
||||
expiryDate: 2024-10-30 # deprecated 2022-10-30 in v0.123.0
|
||||
{{< /code-toggle >}}
|
||||
|
||||
Set the `expiryDate` to one year from the date of deprecation, and add a brief front matter comment to explain the setting.
|
||||
Set the `expiryDate` to two years from the date of deprecation, and add a brief front matter comment to explain the setting.
|
||||
|
||||
## GitHub workflow
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ action:
|
||||
related: []
|
||||
returnType: int
|
||||
signatures: [crypto.FNV32a STRING]
|
||||
expiryDate: 2025-07-31 # deprecated 2024-07-31
|
||||
expiryDate: 2026-07-31 # deprecated 2024-07-31 in v0.129.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.129.0 %}}
|
||||
|
||||
@@ -9,7 +9,7 @@ action:
|
||||
returnType: '[][]string'
|
||||
signatures: ['data.GetCSV SEPARATOR INPUT... [OPTIONS]']
|
||||
toc: true
|
||||
expiryDate: 2025-02-19 # deprecated 2024-02-19
|
||||
expiryDate: 2026-02-19 # deprecated 2024-02-19 in v0.123.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.123.0 %}}
|
||||
|
||||
@@ -9,7 +9,7 @@ action:
|
||||
returnType: any
|
||||
signatures: ['data.GetJSON INPUT... [OPTIONS]']
|
||||
toc: true
|
||||
expiryDate: 2025-02-19 # deprecated 2024-02-19
|
||||
expiryDate: 2026-02-19 # deprecated 2024-02-19 in v0.123.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.123.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.Babel [OPTIONS] RESOURCE']
|
||||
expiryDate: 2025-06-24 # deprecated 2024-06-24
|
||||
expiryDate: 2026-06-24 # deprecated 2024-06-24 in v0.128.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.128.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.PostCSS [OPTIONS] RESOURCE']
|
||||
expiryDate: 2025-06-24 # deprecated 2024-06-24
|
||||
expiryDate: 2026-06-24 # deprecated 2024-06-24 in v0.128.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.128.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.ToCSS [OPTIONS] RESOURCE']
|
||||
expiryDate: 2025-06-24 # deprecated 2024-06-24
|
||||
expiryDate: 2026-06-24 # deprecated 2024-06-24 in v0.128.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.128.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: maps.Scratch
|
||||
signatures: [PAGE.Scratch]
|
||||
expiryDate: 2025-11-18 # deprecated 2024-11-18
|
||||
expiryDate: 2026-11-18 # deprecated 2024-11-18 (soft)
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.138.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: int
|
||||
signatures: [PAGER.PageSize]
|
||||
expiryDate: 2025-06-09 # deprecated 2024-06-09
|
||||
expiryDate: 2026-06-09 # deprecated 2024-06-09 in v0.128.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.128.0 %}}
|
||||
|
||||
@@ -9,7 +9,7 @@ action:
|
||||
- methods/resource/Data
|
||||
returnType: resource.resourceError
|
||||
signatures: [RESOURCE.Err]
|
||||
expiryDate: 2026-01-16 # deprecated 2025-01-16
|
||||
expiryDate: 2027-01-16 # deprecated 2025-01-16 in v0.141.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.141.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: maps.Scratch
|
||||
signatures: [SHORTCODE.Scratch]
|
||||
expiryDate: 2025-11-18 # deprecated 2024-11-18
|
||||
expiryDate: 2026-11-18 # deprecated 2024-11-18 (soft)
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.139.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: string
|
||||
signatures: [SITE.DisqusShortname]
|
||||
expiryDate: 2024-10-30 # deprecated 2023-10-30
|
||||
expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.120.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: string
|
||||
signatures: [SITE.GoogleAnalytics]
|
||||
expiryDate: 2024-10-30 # deprecated 2023-10-30
|
||||
expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.120.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: bool
|
||||
signatures: [SITE.IsDevelopment]
|
||||
expiryDate: 2024-10-30 # deprecated 2023-10-30
|
||||
expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.120.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: bool
|
||||
signatures: [SITE.IsMultiLingual]
|
||||
expiryDate: 2025-03-16 # deprecated 2024-03-16
|
||||
expiryDate: 2026-03-16 # deprecated 2024-03-16 in 0.124.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.124.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: bool
|
||||
signatures: [SITE.IsServer]
|
||||
expiryDate: 2024-10-30 # deprecated 2023-10-30
|
||||
expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.120.0 %}}
|
||||
|
||||
@@ -7,7 +7,7 @@ action:
|
||||
related: []
|
||||
returnType: time.Time
|
||||
signatures: [SITE.LastChange]
|
||||
expiryDate: 2025-02-19 # deprecated 2024-02-19
|
||||
expiryDate: 2026-02-19 # deprecated 2024-02-19 in v0.123.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.123.0 %}}
|
||||
|
||||
@@ -9,7 +9,7 @@ menu:
|
||||
parent: shortcodes
|
||||
weight:
|
||||
weight:
|
||||
expiryDate: 2025-01-22 # Deprecated in v0.143.0. Use HTML comments instead
|
||||
expiryDate: 2025-01-22 # deprecated 2025-02-01 in v0.143.0 and immediately removed from the documentation
|
||||
---
|
||||
|
||||
{{% note %}}
|
||||
|
||||
@@ -8,7 +8,7 @@ menu:
|
||||
parent: shortcodes
|
||||
weight:
|
||||
weight:
|
||||
expiryDate: 2027-01-31 # Deprecated in v0.143.0. Keep this around for a couple of years because it contains instructions for creating a replacement.
|
||||
expiryDate: 2027-02-01 # deprecated 2025-02-01 in v0.143.0
|
||||
---
|
||||
|
||||
{{% deprecated-in 0.143.0 %}}
|
||||
|
||||
@@ -33,6 +33,12 @@ After the project team deprecates something in code, Hugo will:
|
||||
1. Log a WARN message for another 12 minor releases
|
||||
1. Log an ERROR message and fail the build thereafter
|
||||
|
||||
The project team will:
|
||||
|
||||
1. On the deprecation date, update the documentation with a note describing the deprecation and any relevant alternatives.
|
||||
1. Remove the code six or more minor releases after Hugo begins logging ERROR messages and failing the build. At that point, Hugo will throw an error, but the error message will no longer mention the deprecation.
|
||||
1. Remove the corresponding documentation two years after the deprecation date.
|
||||
|
||||
To see the INFO messages, you must use the `--logLevel` command line flag:
|
||||
|
||||
```text
|
||||
|
||||
Reference in New Issue
Block a user