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

docs(connectors): clarify jobError's relationship to incidents #4206

Merged
merged 4 commits into from
Aug 29, 2024

Conversation

ev-codes
Copy link
Contributor

@ev-codes ev-codes commented Aug 28, 2024

Description

Making this more function more clear for users who are familiar with BPMN concepts, but who are now learning Connectors.

When should this change go live?

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

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@ev-codes ev-codes self-assigned this Aug 28, 2024
Copy link
Contributor

github-actions bot commented Aug 28, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@ev-codes
Copy link
Contributor Author

After I get some initial feedback, I will:

  • copy my final draft to /versioned_docs
  • add more reviewers
  • mark this PR as ready 😄

@ev-codes ev-codes requested a review from nikku August 28, 2024 15:47
@ev-codes ev-codes added the component:connectors Issues related to the connectors project. label Aug 28, 2024

Use the provided FEEL functions:

- [`bpmnError`](#function-bpmnerror) to create a BPMN error object. This triggers a [ThrowError call](https://docs.camunda.io/docs/components/best-practices/development/dealing-with-problems-and-exceptions/#understanding-workers) to the workflow engine.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[all.hrefProduction] Improper link format: 'ThrowError call'. Please use relative URLs.

Use the provided FEEL functions:

- [`bpmnError`](#function-bpmnerror) to create a BPMN error object. This triggers a [ThrowError call](https://docs.camunda.io/docs/components/best-practices/development/dealing-with-problems-and-exceptions/#understanding-workers) to the workflow engine.
- [`jobError`](#function-jobError) to create a fail job object. This triggers a [FailJob call](https://docs.camunda.io/docs/components/best-practices/development/dealing-with-problems-and-exceptions/#understanding-workers) to the workflow engine.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[all.hrefProduction] Improper link format: 'FailJob call'. Please use relative URLs.

@ev-codes ev-codes requested a review from nikku August 29, 2024 11:06
Copy link
Member

@nikku nikku left a comment

Choose a reason for hiding this comment

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

Amazing, exactly what I wanted to see :).

nikku
nikku previously approved these changes Aug 29, 2024
@nikku
Copy link
Member

nikku commented Aug 29, 2024

👏

@ev-codes ev-codes marked this pull request as ready for review August 29, 2024 12:40
@ev-codes ev-codes requested a review from a team August 29, 2024 12:40
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

🙌 Love to see it, thank you for backporting!

@ev-codes ev-codes merged commit 64bb18c into main Aug 29, 2024
9 checks passed
@ev-codes ev-codes deleted the ev/clarify-job-error branch August 29, 2024 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:connectors Issues related to the connectors project.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants