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

feat(api-clients/grpc): add variables argument for FailJob gRPC #1388

Merged
merged 2 commits into from
Oct 20, 2022

Conversation

skayliu
Copy link
Contributor

@skayliu skayliu commented Oct 13, 2022

What is the purpose of the change

Add variables argument for FailJob gRPC.

closes #1387

Are there related marketing activities

No.

When should this change go live?

May be C8.2.

PR Checklist

  • My changes apply to an already released version, and I have added them to the relevant /versioned_docs directory, or they are not for an already released version.
  • My changes apply to future versions, and I have added them to the main /docs directory, or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@skayliu skayliu force-pushed the 1387-docs-fail-job-variables branch from 56c3188 to 7a0e98f Compare October 17, 2022 14:00
@skayliu
Copy link
Contributor Author

skayliu commented Oct 17, 2022

Hi, @korthout, I've updated the doc, Please review this, Thank you.

@korthout
Copy link
Member

korthout commented Oct 17, 2022

Thanks @skayliu ❤️ , I'll have a look at this in the coming days.

@korthout korthout self-requested a review October 17, 2022 14:27
korthout
korthout previously approved these changes Oct 18, 2022
Copy link
Member

@korthout korthout left a comment

Choose a reason for hiding this comment

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

Thanks @skayliu 🚀

This change made me wonder whether we also need to update:

❓ But I'm not sure, because that page explains the basic job worker concept while this feature is for rather advanced use cases. I'd be curious to hear your opinion about this.

🔧 Please consider my suggestion

docs/apis-clients/grpc.md Outdated Show resolved Hide resolved
@skayliu
Copy link
Contributor Author

skayliu commented Oct 18, 2022

@korthout what you think add these?

When Completing or failing jobs with variables, the variables are merged into the process of the job's associated task.

  • If Completing a job the variables are propagated from the scope of the task to its higher scopes.
  • If Failing a job the variables are only created in the local scope of the task.

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.

No adjustments from a technical writing perspective on this one 👍

Copy link
Member

@korthout korthout left a comment

Choose a reason for hiding this comment

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

Thanks for the additional changes @skayliu

@christinaausley Let me know what you think about linking ahead in the concepts and about my grammar suggestion.

docs/components/concepts/job-workers.md Outdated Show resolved Hide resolved
docs/components/concepts/job-workers.md Outdated Show resolved Hide resolved
Copy link
Member

@korthout korthout left a comment

Choose a reason for hiding this comment

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

LGTM 🏅

@korthout korthout merged commit 76fb401 into camunda:main Oct 20, 2022
@skayliu skayliu deleted the 1387-docs-fail-job-variables branch October 20, 2022 14:53
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.

I can set variables when failing a job
3 participants