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

Added info on breaking changes to release notes for 2.0.0 #43

Conversation

dmccoystephenson
Copy link
Collaborator

@dmccoystephenson dmccoystephenson commented Feb 16, 2024

Problem

The switch to J2735 2020 means that 2016 TIMs will no longer be processed successfully by the ACM. There is no mention of this in the release notes.

Solution

Information on breaking changes has been added to the release notes.

@@ -19,6 +19,9 @@ Known Issues:
- The do_kafka_test.sh script in the project's root directory is currently not running successfully. The issue is being investigated and will be addressed in a future update.
- According to Valgrind, a minor memory leak has been detected. The development team is aware of this and is actively working on resolving it.

Breaking Changes
- Users should note that due to the switch to J2735 2020, TIMs conforming to J2735 2016 will no longer be encoded/decoded correctly. This is due to the fact that the J2735 2020 standard has renamed some fields for TIMs. Users should ensure that their TIMs are updated to conform to the J2735 2020 standard.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's add to this last sentence saying that the ODE updates handle this change already, but any outside calling applications will need to update their systems.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The last sentence has been rephrased & added to for clarity.

Copy link
Collaborator

@payneBrandon payneBrandon left a comment

Choose a reason for hiding this comment

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

One comment, looks good!

@dmccoystephenson
Copy link
Collaborator Author

This is ready for re-review. @payneBrandon

Copy link
Collaborator

@drewjj drewjj left a comment

Choose a reason for hiding this comment

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

Looks good

@dmccoystephenson dmccoystephenson marked this pull request as draft February 23, 2024 19:25
@dmccoystephenson dmccoystephenson changed the title Added info on breaking changes to release notes for 1.6.0 Added info on breaking changes to release notes for 2.0.0 Feb 23, 2024
@dmccoystephenson dmccoystephenson marked this pull request as ready for review February 23, 2024 19:28
Copy link
Collaborator

@payneBrandon payneBrandon left a comment

Choose a reason for hiding this comment

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

lgtm!

@dan-du-car dan-du-car merged commit 521ac8a into usdot-jpo-ode:develop Feb 23, 2024
2 checks passed
@dmccoystephenson dmccoystephenson deleted the docs/add-j2735-warning-to-release-notes branch February 23, 2024 20:43
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.

4 participants