-
Notifications
You must be signed in to change notification settings - Fork 10
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
[#513] Release 3.0.0 #517
base: master
Are you sure you want to change the base?
[#513] Release 3.0.0 #517
Conversation
Release/2.4.4
docs/api/index.rst
Outdated
`Objecttypes API`_ 2.0.0 ( | ||
`Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`__, | ||
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`__ | ||
`Objecttypes API`_ 2.2.2 ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This applies here too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it should refer to an unreleased objecttypes but if objecttypes is released first, then I say it should.
Also, should it referrer to Objecttypes 3.0.0 since that will remove also removed API V1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if the specification version matches the application version necessarily (see my comment at maykinmedia/objecttypes-api#149 (comment))
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this version number refers to the specification version, we could refer here to the latest specification version (2.0.0
in this case?) and use the link of the latest application openapi specification (that of 3.0.0
) so that we don't link people to older openapi specifications 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
docs/api/index.rst
Outdated
`Objecttypes API`_ 2.0.0 ( | ||
`Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`__, | ||
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`__ | ||
`Objecttypes API`_ 2.2.2 ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it should refer to an unreleased objecttypes but if objecttypes is released first, then I say it should.
Also, should it referrer to Objecttypes 3.0.0 since that will remove also removed API V1
With this, are we removing support for Objecttypes-api < 3.0.0? |
docs/api/index.rst
Outdated
`Objecttypes API`_ 2.0.0 ( | ||
`Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`__, | ||
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`__ | ||
`Objecttypes API`_ 2.2.2 ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if the specification version matches the application version necessarily (see my comment at maykinmedia/objecttypes-api#149 (comment))
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just the question remaining about the listed API spec versions in the readme, but since that seems to be incorrect on main already, I won't let it block this release
@@ -38,7 +38,16 @@ Versie Release datum API specificatie | |||
============== ============== ============================= | |||
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_, | |||
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_, | |||
(`verschillen <https://github.com/maykinmedia/objects-api/compare/2.4.3..master#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_) | |||
(`verschillen <https://github.com/maykinmedia/objects-api/compare/3.0.0..master>`_) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as here: https://github.com/maykinmedia/objecttypes-api/pull/149/files#r1917934515
@@ -38,7 +38,16 @@ Versie Release datum API specificatie | |||
============== ============== ============================= | |||
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_, | |||
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_, | |||
(`verschillen <https://github.com/maykinmedia/objects-api/compare/2.4.3..master#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_) | |||
(`verschillen <https://github.com/maykinmedia/objects-api/compare/3.0.0..master>`_) | |||
3.0.0 2025-01-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reminder to change this date to when it's going to be released
3.0.0 2025-01-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_, | |
3.0.0 2025-01-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_, |
@@ -36,10 +36,19 @@ Version Release date API specification | |||
============== ============== ============================= | |||
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_, | |||
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_, | |||
(`diff <https://github.com/maykinmedia/objects-api/compare/2.4.3..master#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_) | |||
(`diff <https://github.com/maykinmedia/objects-api/compare/3.0.0..master>`_) | |||
3.0.0 2025-01-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reminder to change this date to when it's going to be released
3.0.0 2025-01-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_, | |
3.0.0 2025-01-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_, |
softwareVersion: 2.4.3 | ||
releaseDate: '2021-01-13' | ||
softwareVersion: 3.0.0 | ||
releaseDate: '2025-01-14' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reminder to change this when it's released
2.x.x | ||
===== | ||
*TBD* | ||
3.0.0 (2025-01-14) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reminder to change this when it's released
This is not breaking for OF, ZAC, KISS, OIP, ABC. I checked this with the PO's. |
Partially fixes #513
Changes
Adds changes required for releasing
3.0.0
. This is the major release part.