-
Notifications
You must be signed in to change notification settings - Fork 40
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
Be able to configure meta-data with rules (and pass them to reports) #165
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Feb 17, 2025
barmac
approved these changes
Feb 17, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
This is most handy for fiddling with meta-data exposed by rules, i.e. to alter / inject documentation urls or other information. This intentionally cannot be used to alter rule configuration or activation; this must be done via a custom bpmnlint configuration.
nikku
added a commit
that referenced
this pull request
Feb 17, 2025
nikku
added a commit
that referenced
this pull request
Feb 17, 2025
nikku
added a commit
that referenced
this pull request
Feb 17, 2025
4 tasks
nikku
added a commit
that referenced
this pull request
Feb 17, 2025
nikku
added a commit
that referenced
this pull request
Feb 17, 2025
barmac
pushed a commit
that referenced
this pull request
Feb 18, 2025
nikku
added a commit
to camunda/bpmnlint-plugin-camunda-compat
that referenced
this pull request
Feb 18, 2025
Previously we injected them via camunda/linting, now we can use the new meta infrastructure provided by bpmnlint itself. Related to bpmn-io/bpmnlint#165
nikku
added a commit
to camunda/bpmnlint-plugin-camunda-compat
that referenced
this pull request
Feb 18, 2025
Previously we injected them via camunda/linting, now we can use the new meta infrastructure provided by bpmnlint itself. Related to bpmn-io/bpmnlint#165
1 task
nikku
added a commit
to bpmn-io/bpmn-js-bpmnlint
that referenced
this pull request
Feb 18, 2025
This embeds a link to the actual documentation, if provided via `meta?.documentation?.url`. Related to bpmn-io/bpmnlint#165 Closes #92 feat: show rule name with report This simplifies things, i.e. users are able to learn about the source of rules.
4 tasks
nikku
added a commit
to bpmn-io/bpmn-js-bpmnlint
that referenced
this pull request
Feb 18, 2025
This embeds a link to the actual documentation, if provided via `meta?.documentation?.url`. Related to bpmn-io/bpmnlint#165 Closes #92 feat: show rule name with report This simplifies things, i.e. users are able to learn about the source of rules.
barmac
pushed a commit
to bpmn-io/bpmn-js-bpmnlint
that referenced
this pull request
Feb 19, 2025
This embeds a link to the actual documentation, if provided via `meta?.documentation?.url`. Related to bpmn-io/bpmnlint#165 Closes #92 feat: show rule name with report This simplifies things, i.e. users are able to learn about the source of rules.
barmac
pushed a commit
to camunda/bpmnlint-plugin-camunda-compat
that referenced
this pull request
Feb 20, 2025
Previously we injected them via camunda/linting, now we can use the new meta infrastructure provided by bpmnlint itself. Related to bpmn-io/bpmnlint#165
nikku
pushed a commit
to camunda/linting
that referenced
this pull request
Feb 20, 2025
We now provide the documentation via upstream. Related to bpmn-io/bpmnlint#165
nikku
pushed a commit
to camunda/linting
that referenced
this pull request
Feb 20, 2025
We now provide the documentation via upstream. Related to bpmn-io/bpmnlint#165
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
As described in #18, this allows rule authors to configure
meta
in a rule. The meta-data will be passed along with reports so downstream integrators, can, i.e. ship custom documentation URLs with their rules (camunda/camunda-modeler#4491).Example rule (exposing a documentation URL)
Example accessing the documentation URL from a report
What's inside this PR
This PR is comprised in two parts:
meta
supportChecklist
To ensure you provided everything we need to look at your PR:
@bpmn-io/sr
toolCloses {LINK_TO_ISSUE}
orRelated to {LINK_TO_ISSUE}
Closes #18
Depends on #163