Skip to content

date field's format property missing with v3.5.0 update (non-documented breaking change) #3026

@renestalder

Description

@renestalder

Describe the bug
As previously submitted to the forum, the format property of the date field was removed without further notice in the official 3.5.0 update or the 3.5.0 changelog itself, which makes it a breaking change in that matter. The current format of the date field therefore falls back to always writing ISO 9075 format without the possibility to change that is in pre-3.5.0 versions. Depending on the use of Kirby, this can lead to unexpected, broken websites, e.g. when retrieving the dates via API, which now will respond with ISO 9075, where in a previous case, the developer might have set a specific, more fitting format for working with JavaScript, like ISO 8601.

To Reproduce
Steps to reproduce the behavior:

  1. Set format on a date field in a Kirby instance older than 3.5.0, e.g. format: "Y-m-d\TH:i:s" (ISO 8601).
  2. Update to 3.5.0
  3. The content files might now show ISO 9075. The format property has no effect any more.

Expected behavior
The format property should still work and alternatively be deprecated and removed in the next major bump (even though I find this property useful, but not necessary). The documentation should still feature it, but with a deprecation or removal warning.

Alternatively, the format property should be added again and kept if there is no conflict or other reason any more why it should be removed.

Screenshots

Kirby Version

3.5.0

Console output

Additional context

My assumption is, this generally might not have a big effect on most developers unless you actually used Kirby headless, which in my case, would have broken all websites I currently maintain if the build system wouldn't have thrown an error.

More context by @distantnative

Indeed a breaking change, one that we/I thought was necessary when I worked on the field weeks ago - if I recall correctly, because of a way they started to conflict with the new display option. However, looking back now, I am not so sure anymore this breaking change was even necessary.

Can we move this discussion to a Github issue (https://github.com/getkirby/kirby/issues 4) or are you both not on Github? I would like to spend some time thinking what would be the best way forward.

And apologies for not finding out about this the proper way. The original PR (#2892) actually still had the info about this breaking change, but we lost it on our way to the release notes. Which of course should not have happened.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions