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

feat(feel): Clarify edge cases in FEEL expressions #4222

Merged
merged 5 commits into from
Sep 5, 2024
Merged

feat(feel): Clarify edge cases in FEEL expressions #4222

merged 5 commits into from
Sep 5, 2024

Conversation

saig0
Copy link
Member

@saig0 saig0 commented Aug 30, 2024 •
edited
Loading

Description

Extend the FEEL documentation to clarify edge cases, related to the following issues:

The changes are relevant for all versions 8.2+.

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/).

@saig0 saig0 added component:zeebe Issues related with Zeebe project deploy Stand up a temporary docs site with this PR labels Aug 30, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 30, 2024 12:53 Destroyed
@saig0
Copy link
Member Author

saig0 commented Aug 30, 2024

Changed pages:

@saig0 saig0 requested a review from nicpuppa August 30, 2024 13:14
nicpuppa
nicpuppa reviewed Sep 5, 2024
View reviewed changes
Copy link
Contributor

@nicpuppa nicpuppa left a comment

Choose a reason for hiding this comment

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

Hey @saig0 I left some small wording suggestions please have a look 👀

docs/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/language-guide/feel-unary-tests.md Outdated Show resolved Hide resolved
.../version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
.../version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
.../version-8.5/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-temporal-expressions.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-unary-tests.md Outdated Show resolved Hide resolved
@saig0 saig0 marked this pull request as ready for review September 5, 2024 07:24
@saig0 saig0 requested a review from a team September 5, 2024 07:24
@github-actions github-actions bot temporarily deployed to camunda-docs September 5, 2024 07:41 Destroyed
nicpuppa
nicpuppa previously approved these changes Sep 5, 2024
View reviewed changes
Copy link
Contributor

@nicpuppa nicpuppa left a comment

Choose a reason for hiding this comment

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

Thanks @saig0 🚀

@mesellings mesellings requested review from mesellings and removed request for a team September 5, 2024 07:52
@mesellings mesellings self-assigned this Sep 5, 2024
@mesellings
Copy link
Contributor

@saig0 I will review this for you 👍

mesellings
mesellings requested changes Sep 5, 2024
View reviewed changes
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm @saig0 - I've left a few changes/suggestions that need to be applied to the other versions as well, and a single typo, but happy to approve if you accept these?

docs/components/modeler/feel/language-guide/feel-temporal-expressions.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/builtin-functions/feel-built-in-functions-string.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
docs/components/modeler/feel/builtin-functions/feel-built-in-functions-conversion.md Outdated Show resolved Hide resolved
mesellings
mesellings previously approved these changes Sep 5, 2024
View reviewed changes
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm 👍

@saig0
Copy link
Member Author

saig0 commented Sep 5, 2024

@mesellings thank you for your fast feedback and suggestions. 👍

saig0 and others added 5 commits September 5, 2024 11:23
@saig0
feat(feel): Clarify built-in function usage
3f69d85 
Extend the description of the functions `date()`, `number()`, and `substring()` to clarify the behavior for certain edge cases.
@saig0
feat(feel): Clarify unary-tests behavior
5eb233f 
Extend the description when a unary-tests expression is fulfilled. Make it explicit what an expression with the special variable `?` must evaluate to true.
@saig0 @nicpuppa
docs: Improve wording
8fc9953 
Co-authored-by: Nicola Puppa <[email protected]>
@saig0 @mesellings
docs: Improve wording
9c7d6fa 
Co-authored-by: Mark Sellings <[email protected]>
@saig0
docs: Improve wording
0c06f6c
@github-actions github-actions bot temporarily deployed to camunda-docs September 5, 2024 09:32 Destroyed
@saig0
Copy link
Member Author

saig0 commented Sep 5, 2024

@mesellings / @nicpuppa I need another approval. I rebased the branch to main.

@saig0 saig0 merged commit 422d194 into main Sep 5, 2024
7 checks passed
@saig0 saig0 deleted the feel-update-docs branch September 5, 2024 11:35
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 5, 2024

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicpuppa nicpuppa nicpuppa approved these changes

@mesellings mesellings mesellings left review comments

Assignees

@saig0 saig0

@mesellings mesellings

Labels
component:zeebe Issues related with Zeebe project deploy Stand up a temporary docs site with this PR
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@saig0 @mesellings @nicpuppa