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.

Sign up for GitHub

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

Jump to bottom

chore: add migration guide for 0.7.x #1238

Merged
merged 8 commits into from
Apr 23, 2024
Merged

chore: add migration guide for 0.7.x #1238

merged 8 commits into from
Apr 23, 2024

Conversation

paullatzelsperger
Copy link
Contributor

@paullatzelsperger paullatzelsperger commented Apr 18, 2024 •
edited
Loading

WHAT

Adds a Migration Guide for moving toward Tractus-X EDC 0.7.x

WHY

.

FURTHER NOTES

List other areas of code that have changed but are not necessarily linked to the main feature. This could be method signature changes, package declarations, bugs that were encountered and were fixed inline, etc.

Closes #1222

@paullatzelsperger paullatzelsperger added the documentation Improvements or additions to documentation label Apr 18, 2024
@paullatzelsperger paullatzelsperger force-pushed the chore/migration_document_0.7.x branch 3 times, most recently from 228edb2 to c6c2c01 Compare April 18, 2024 09:13
@paullatzelsperger paullatzelsperger self-assigned this Apr 18, 2024
@paullatzelsperger paullatzelsperger force-pushed the chore/migration_document_0.7.x branch from c6c2c01 to f2a8186 Compare April 18, 2024 09:15
@paullatzelsperger paullatzelsperger marked this pull request as ready for review April 18, 2024 10:17
saschaisele-zf
saschaisele-zf approved these changes Apr 18, 2024
View reviewed changes
Copy link
Contributor

@saschaisele-zf saschaisele-zf left a comment

Choose a reason for hiding this comment

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

Some typos and some nitpicking.
Looks good overall though.

@rafaelmag110
Copy link
Contributor

rafaelmag110 commented Apr 18, 2024 •
edited
Loading

Hey @paullatzelsperger
Since the AWS S3 Extension is also included in the TX EDC 0.7.X distribution, I believe it could be beneficial to mention the new improvements it had. I can create a small line summarizing the improvements.

"The AWS S3 Extension also has been improved and now enables the user to specify S3 object prefixes in the data address. This enables the transfer of multiple files within on single transer process. For more information, visit the extension readme.

@paullatzelsperger
Copy link
Contributor Author

Hey @paullatzelsperger Since the AWS S3 Extension is also included in the TX EDC 0.7.X distribution, I believe it could be beneficial to mention the new improvements it had. I can create a small line summarizing the improvements.

cool, thanks, added!

arnoweiss
arnoweiss reviewed Apr 23, 2024
View reviewed changes
docs/migration/Version_0.5.x_0.7.x.md
### 5.3 EDRs

The 0.5.4 EDRs API was removed due the adoption of DPS (data plane signaling) and reborn under a different shape
in `/v2/edrs`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggest to add:

"Additionally, the option to register a consumer-side HTTP-callback via receiverHttpEndpoint in the POST /transferprocesses call was removed. Consumer apps should use the /v2/edrs API instead."

Copy link
Contributor

Choose a reason for hiding this comment

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

Probably we can add this in the section ## 2. Changes to EDR handling and APIs where we mention the removal of the config backendService.httpProxyTokenReceiverUrl. We can add the removal of the receiverHttpEndpoint in transfer process as well

Copy link
Contributor Author

Choose a reason for hiding this comment

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

do you mind adding a GitHub Suggestion to the PR? CTRL-G (or CMD-G on macs)...

arnoweiss
arnoweiss approved these changes Apr 23, 2024
View reviewed changes
Copy link
Contributor

@arnoweiss arnoweiss left a comment

Choose a reason for hiding this comment

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

looks complete to me, thanks for compiling!

@paullatzelsperger paullatzelsperger force-pushed the chore/migration_document_0.7.x branch from 42724ff to 0abf729 Compare April 23, 2024 09:14
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@paullatzelsperger paullatzelsperger merged commit c9f7892 into eclipse-tractusx:main Apr 23, 2024
31 checks passed
@paullatzelsperger paullatzelsperger deleted the chore/migration_document_0.7.x branch April 23, 2024 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wolf4ood wolf4ood wolf4ood approved these changes

@jimmarino jimmarino jimmarino approved these changes

@arnoweiss arnoweiss arnoweiss approved these changes

@saschaisele-zf saschaisele-zf saschaisele-zf approved these changes

@florianrusch-zf florianrusch-zf Awaiting requested review from florianrusch-zf

@ndr-brt ndr-brt Awaiting requested review from ndr-brt

@stefan-ettl stefan-ettl Awaiting requested review from stefan-ettl

Assignees

@paullatzelsperger paullatzelsperger

Labels
documentation Improvements or additions to documentation
Projects
EDC PR Board
Status: Merged
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@paullatzelsperger @rafaelmag110 @wolf4ood @jimmarino @arnoweiss @saschaisele-zf