OpenAPI-Specification icon indicating copy to clipboard operation
OpenAPI-Specification copied to clipboard

Update ReSpec versions

Open github-actions[bot] opened this issue 1 year ago • 4 comments

This pull request is automatically triggered by GitHub action respec.

The versions/v*.md files have changed, so the HTML files are automatically being regenerated.

github-actions[bot] avatar Mar 28 '24 16:03 github-actions[bot]

@lornajane oof.. and really, each published spec should show the then-current TSC members, not the now-current ones.

handrews avatar Mar 28 '24 21:03 handrews

The build script expects "Emeritus" to be the second unordered list: https://github.com/OAI/OpenAPI-Specification/blob/64111cc3aa5a59ffc631a4987a87550691a35584/scripts/md2html/md2html.js#L121-L125

Now the second section is "Provisional".

Should provisional maintainers be mentioned in the specification? If not, we could simply decide not to publish specifications during the probation period 😄

ralfhandl avatar May 03 '24 07:05 ralfhandl

each published spec should show the then-current TSC members

Per patch version, or only per minor version? Should 3.0.1, 3.0.2, and 3.0.3 show the 3.0.0 TSC state, or the TSC state per publishing date?

Minor complication: MAINTAINERS.md was created between publication of 3.0.0 and 3.0.1 and years after publication of 2.0. It does not reflect the TSC state when 2.0 was published, and the editor's list currently shown on https://spec.openapis.org/oas/v2.0 is not in sync with the publication date.

ralfhandl avatar May 03 '24 08:05 ralfhandl

Should provisional maintainers be mentioned in the specification? If not, we could simply decide not to publish specifications during the probation period 😄

Or we could fix the build script? (#3693) There's still also the problem that it's not attaching the maintainers from the right commit to each document, so we need to fix some part of the script no matter what. OAS 3.0.0-3.1.0 should not be published with the current TSC membership listed.

Minor complication: MAINTAINERS.md was created between publication of 3.0.0 and 3.0.1 and years after publication of 2.0. It does not reflect the TSC state when 2.0 was published, and the editor's list currently shown on https://spec.openapis.org/oas/v2.0 is not in sync with the publication date.

The script actually special-cases 2.0, so I'm not sure why that's wrong.

I'd request that we continue this in #3693 and a new PR to fix it, rather than this PR.

handrews avatar May 03 '24 16:05 handrews

@ralfhandl it now looks like Jason Harmon shows up only as a former editor, never current. Is that expected based on #3782, or should he have been included in the static content for 2.0?

handrews avatar May 14 '24 14:05 handrews

@ralfhandl it now looks like Jason Harmon shows up only as a former editor, never current. Is that expected based on #3782, or should he have been included in the static content for 2.0?

His activity seems to start after 2.0 was published, so the 2.0 editor's lists seem correct.

His activity seems to end before 3.0.0 was published, so he should appear as a former editor for 3.0.0. I'll have to create another snapshot of MAINTAINERS.md for 3.0.0 instead of reusing the 2.0 one: #3808

ralfhandl avatar May 15 '24 08:05 ralfhandl