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

fix(rest-connector): add hint about breaking change in 8.6 #5137

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ztefanie
Copy link
Contributor

@ztefanie ztefanie commented Mar 4, 2025

Description

The behavior for grouping headers had a breaking change from 8.5 to 8.6. This is now documented.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the DevEx team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and:
    • are in the /docs directory (version 8.8).
    • are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@ztefanie ztefanie added the available & undocumented This is already available but undocumented and should be released within a week. label Mar 4, 2025
@ztefanie ztefanie requested review from johnBgood, neal-dennis and a team March 4, 2025 09:48
@akeller akeller added the deploy Stand up a temporary docs site with this PR label Mar 4, 2025
@akeller
Copy link
Member

akeller commented Mar 4, 2025

@ztefanie, can you link to an issue or support ticket for reviewers to have a complete picture? Was this really a breaking change or a bug fix that was addressed in a patch?

@akeller akeller added the component:connectors Issues related to the connectors project. label Mar 4, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs March 4, 2025 20:42 Destroyed
@ztefanie
Copy link
Contributor Author

ztefanie commented Mar 5, 2025

@ztefanie, can you link to an issue or support ticket for reviewers to have a complete picture? Was this really a breaking change or a bug fix that was addressed in a patch?

Sure it is about this There is a discussion on going in the incident slack channel: #inc-support-26056-multiple-set-cookie-headers

@ztefanie ztefanie added the hold This issue is parked, do not merge. label Mar 5, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs March 5, 2025 13:42 Destroyed
@akeller akeller added the support Issues related to support tickets label Mar 5, 2025
johnBgood
johnBgood previously approved these changes Mar 5, 2025
Copy link
Contributor

@johnBgood johnBgood left a comment

Choose a reason for hiding this comment

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

Thank you!

@github-actions github-actions bot temporarily deployed to camunda-docs March 5, 2025 14:14 Destroyed
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

This breaking change should also likely go into announcements.

Copy link
Contributor

github-actions bot commented Mar 6, 2025

👋 🤖 🤔 Hello, @ztefanie! Did you make your changes in all the right places?

These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in docs/.

  • versioned_docs/version-8.6/reference/announcements.md
These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • versioned_docs/version-8.6/reference/announcements.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@github-actions github-actions bot temporarily deployed to camunda-docs March 6, 2025 13:04 Destroyed
@ztefanie ztefanie force-pushed the rest-connector-docs-add-hint-about-breaking-change-in-8.6.0 branch from c0177e0 to 9d0c1f2 Compare March 6, 2025 13:12
@ztefanie
Copy link
Contributor Author

ztefanie commented Mar 6, 2025

See related issue

I did not document the "breaking change" in the last two lines of the table below, because i consider this a bug fix and not a breaking change.

Behavior Expected result
Users are on 8.5 and update to 8.6.11 nothing should break
Users are on 8.5 and update to 8.6.7 will break but should be fixed with manually editing the template
Users are on 8.6.7 and did edit their template and update to 8.6.11 should work fine
Users are on 8.6.7 and did not edit their template and update to 8.6.11 breaking change: if using a set cookie header in a feel result, this will fail, as now an array is returned
Users are on 8.6.7 or higher and update to 8.7 breaking change: if using a set cookie header in a feel result, this will fail, as now an array is returned

@github-actions github-actions bot temporarily deployed to camunda-docs March 6, 2025 13:21 Destroyed
Copy link
Contributor

github-actions bot commented Mar 6, 2025

The preview environment relating to the commit bb60a8c has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-5137/index.html

Copy link
Contributor

@neal-dennis neal-dennis left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
available & undocumented This is already available but undocumented and should be released within a week. component:connectors Issues related to the connectors project. deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge. support Issues related to support tickets
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

5 participants