Skip to content
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

api break from CTBase update #122

Merged
merged 1 commit into from
Jun 23, 2024
Merged

Conversation

jbcaillau
Copy link
Member

@jbcaillau jbcaillau commented Jun 23, 2024

@PierreMartinon check #121

New release needed

@ocots a few thoughts:

  • API break so CTBase.jl release should have been 1.0.0?
  • I could (should...) have provided aliases / patches in CTBase.jl to ensure compat. with CTDirect.jl
  • typical example showing that global test in our OptimalControl.jl / CTxxxx.jl hierarchy are in order; maybe could be included in OptimalControl.jl CI

@jbcaillau jbcaillau linked an issue Jun 23, 2024 that may be closed by this pull request
@ocots ocots merged commit 20d4d77 into main Jun 23, 2024
4 checks passed
@ocots ocots deleted the 121-urgent-fix-api-break-for-ctbase branch June 23, 2024 19:43
@ocots
Copy link
Member

ocots commented Jun 23, 2024

Semantic versioning: https://semver.org/#spec-item-4

@ocots
Copy link
Member

ocots commented Jun 23, 2024

@PierreMartinon check #121

New release needed

@ocots a few thoughts:

  • API break so CTBase.jl release should have been 1.0.0?

No. Semantic versioning: https://semver.org/#spec-item-4

  • I could (should...) have provided aliases / patches in CTBase.jl to ensure compat. with CTDirect.jl

Patch version Z (x.y.Z | x > 0) MUST be incremented if only backward compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.

Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backward compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented.

Major version X (X.y.z | X > 0) MUST be incremented if any backward incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor versions MUST be reset to 0 when major version is incremented.

  • typical example showing that global test in our OptimalControl.jl / CTxxxx.jl hierarchy are in order; maybe could be included in OptimalControl.jl CI

??

@jbcaillau
Copy link
Member Author

Thanks @ocots for the new release

@ocots a few thoughts:

  • API break so CTBase.jl release should have been 1.0.0?

No. Semantic versioning: https://semver.org/#spec-item-4

Major version X (X.y.z | X > 0) MUST be incremented if any backward incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor versions MUST be reset to 0 when major version is incremented.

From the same ref.:

IMG_3274

Going from nlp_constraints to nlp_constraints! is an incompatible API change

  • typical example showing that global test in our OptimalControl.jl / CTxxxx.jl hierarchy are in order; maybe could be included in OptimalControl.jl CI

??

CTBase.jl tests were OK, not those in CTDirect.jl anymore; could have broken instantly OptimalControl.jl for anyone willing to install. Actually, was still OK since CTBase.jl has not yet been updated to v0.10:

IMG_3275

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.

Urgent fix - API break for CTBase
4 participants