Skip to content

Add month to Relative JSON Pointer's spec <date/> #1259

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

Merged
merged 1 commit into from
Aug 2, 2022
Merged

Add month to Relative JSON Pointer's spec <date/> #1259

merged 1 commit into from
Aug 2, 2022

Conversation

jviotti
Copy link
Member

@jviotti jviotti commented Jul 20, 2022

It is currently not possible to build the Relative JSON Pointer's spec.
xml2rfc will complain about the date tag not being the current year
while not having a month set either.

This is the error I get:

xml2rfc --html relative-json-pointer.xml -o relative-json-pointer.html
json-schema-spec/relative-json-pointer.xml(16): Error: Expected <date> to have the current year when month is missing, but found '2021'
Unable to complete processing relative-json-pointer.xml

This PR changes the <date/> year to the current year.

Signed-off-by: Juan Cruz Viotti [email protected]

@jviotti
Copy link
Member Author

jviotti commented Jul 20, 2022

Found this while working on reviving the CI on this repo

@Relequestual
Copy link
Member

Relative JSON Pointer has not been updated in 2022, and so should not be built with that date.
It's an "error", but not a crash, so more like a warn.
I think the "correct" solution is to add the Month and Day, as required per https://datatracker.ietf.org/doc/html/rfc7991#section-2.17

@Relequestual
Copy link
Member

Your PR title says "add month" but you've actually changed the year to this year.

@jviotti
Copy link
Member Author

jviotti commented Jul 22, 2022

@Relequestual

I think the "correct" solution is to add the Month and Day,

Sounds good. I'll change the dates to match https://json-schema.org/draft/2020-12/relative-json-pointer.html then.

Your PR title says "add month" but you've actually changed the year to this year.

Oops! I was initially adding the month, then thought changing the year might be expected and forgot to update the description.

@handrews
Copy link
Contributor

Usually we just bump the year.

@jviotti
Copy link
Member Author

jviotti commented Jul 22, 2022

Done!

@jviotti
Copy link
Member Author

jviotti commented Jul 22, 2022

@handrews Yeah, that was my impression too, given that the latest draft's date is January 2020, but the current year on the XML file was already 2021.

@jviotti
Copy link
Member Author

jviotti commented Jul 28, 2022

Ping @Relequestual @handrews . How should we move forward here? This is a pre-requisite for reviving the CI on this repo

@handrews
Copy link
Contributor

Just update the year to 2022 and don't put a month, that's what we've always done.

It is currently not possible to build the Relative JSON Pointer's spec.
`xml2rfc` will complain about the date tag not being the current year
while not having a month set either.

This is the error I get:

```
xml2rfc --html relative-json-pointer.xml -o relative-json-pointer.html
json-schema-spec/relative-json-pointer.xml(16): Error: Expected <date> to have the current year when month is missing, but found '2021'
Unable to complete processing relative-json-pointer.xml
```

This PR changes the `<date/>` year to the current year.

Signed-off-by: Juan Cruz Viotti <[email protected]>
@jviotti
Copy link
Member Author

jviotti commented Jul 29, 2022

Done!

@Relequestual
Copy link
Member

Just update the year to 2022 and don't put a month, that's what we've always done.

Isn't it supposed to reference the year of publicaiton?

I guess it doesn't matter unless we publish that document anywhere, like on the website.

Copy link
Contributor

@handrews handrews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it supposed to reference the year of publicaiton?

It's always the current year, and then when it's published that's the year of publication.

We have literally done this every year with every spec we edited that year.

@Relequestual
Copy link
Member

I guess that's fine. I just don't want someone turning up asking what change for that spec when it didn't get any changes.

@handrews
Copy link
Contributor

@Relequestual it won't build without it, and build errors are a bad thing.

@Relequestual
Copy link
Member

I've clearly missed that we have done this every year regardless of the spec release process, so please ignore me and proceed =]

@Relequestual Relequestual merged commit 8e74544 into json-schema-org:main Aug 2, 2022
@jviotti jviotti deleted the relative-json-pointer-date branch August 2, 2022 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants