mirrors/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-26 05:30:54 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

common/hugo: Adjust deprecation timing and message

Browse source 
Closes #13333
This commit is contained in:
Joe Mooring 2025-02-02 08:55:47 -08:00 • committed by Bjørn Erik Pedersen
parent 835579b338
commit 7104de83ce
3 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

10
common/hugo/hugo.go
View file

@ -418,7 +418,7 @@ func Deprecate(item, alternative string, version string) {
func DeprecateLevel(item, alternative, version string, level logg.Level) { func DeprecateLevel(item, alternative, version string, level logg.Level) {
var msg string var msg string
if level == logg.LevelError { if level == logg.LevelError {
msg = fmt.Sprintf("%s was deprecated in Hugo %s and will be removed in Hugo %s. %s", item, version, CurrentVersion.Next().ReleaseVersion(), alternative) msg = fmt.Sprintf("%s was deprecated in Hugo %s and subsequently removed. %s", item, version, alternative)
} else { } else {
msg = fmt.Sprintf("%s was deprecated in Hugo %s and will be removed in a future release. %s", item, version, alternative) msg = fmt.Sprintf("%s was deprecated in Hugo %s and will be removed in a future release. %s", item, version, alternative)
} }
@ -434,11 +434,11 @@ func deprecationLogLevelFromVersion(ver string) logg.Level {
to := CurrentVersion to := CurrentVersion
minorDiff := to.Minor - from.Minor minorDiff := to.Minor - from.Minor
switch { switch {
case minorDiff >= 12: case minorDiff >= 15:
// Start failing the build after about a year. // Start failing the build after about 15 months.
return logg.LevelError return logg.LevelError
case minorDiff >= 6: case minorDiff >= 3:
// Start printing warnings after about six months. // Start printing warnings after about 3 months.
return logg.LevelWarn return logg.LevelWarn
default: default:
return logg.LevelInfo return logg.LevelInfo

8
common/hugo/hugo_test.go
View file

@ -57,11 +57,11 @@ func TestDeprecationLogLevelFromVersion(t *testing.T) {
c.Assert(deprecationLogLevelFromVersion("0.55.0"), qt.Equals, logg.LevelError) c.Assert(deprecationLogLevelFromVersion("0.55.0"), qt.Equals, logg.LevelError)
ver := CurrentVersion ver := CurrentVersion
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelInfo) c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelInfo)
ver.Minor -= 1 ver.Minor -= 3
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelInfo)
ver.Minor -= 6
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelWarn) c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelWarn)
ver.Minor -= 6 ver.Minor -= 4
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelWarn)
ver.Minor -= 13
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelError) c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelError)
// Added just to find the threshold for where we can remove deprecated items. // Added just to find the threshold for where we can remove deprecated items.

4
tpl/debug/debug.go
View file

@ -171,7 +171,7 @@ func (ns *Namespace) TestDeprecationInfo(item, alternative string) string {
// Internal template func, used in tests only. // Internal template func, used in tests only.
func (ns *Namespace) TestDeprecationWarn(item, alternative string) string { func (ns *Namespace) TestDeprecationWarn(item, alternative string) string {
v := hugo.CurrentVersion v := hugo.CurrentVersion
v.Minor -= 6 v.Minor -= 3
hugo.Deprecate(item, alternative, v.String()) hugo.Deprecate(item, alternative, v.String())
return "" return ""
} }
@ -179,7 +179,7 @@ func (ns *Namespace) TestDeprecationWarn(item, alternative string) string {
// Internal template func, used in tests only. // Internal template func, used in tests only.
func (ns *Namespace) TestDeprecationErr(item, alternative string) string { func (ns *Namespace) TestDeprecationErr(item, alternative string) string {
v := hugo.CurrentVersion v := hugo.CurrentVersion
v.Minor -= 12 v.Minor -= 15
hugo.Deprecate(item, alternative, v.String()) hugo.Deprecate(item, alternative, v.String())
return "" return ""
} }