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

Add documentation URL to built-in rules #167

Merged
merged 3 commits into from
Feb 18, 2025
Merged

Add documentation URL to built-in rules #167

merged 3 commits into from
Feb 18, 2025

Conversation

nikku
Copy link
Member

@nikku nikku commented Feb 17, 2025

Proposed Changes

Builds on top of #165 to provide documentation URL with built-in rules.

What's inside

  • FIX: rule tester did not properly validate meta - 3041995
  • FEAT: attach project documentation URL to built-in rules - a4c7309

Closes #166

Checklist

To ensure you provided everything we need to look at your PR:

  • Brief textual description of the changes present
  • Visual demo attached
  • Steps to try out present, i.e. using the @bpmn-io/sr tool
  • Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

@nikku nikku requested a review from a team February 17, 2025 19:31
@nikku nikku self-assigned this Feb 17, 2025
@nikku nikku requested review from jarekdanielak and barmac and removed request for a team February 17, 2025 19:31
@bpmn-io-tasks bpmn-io-tasks bot added the needs review Review pending label Feb 17, 2025
@nikku nikku force-pushed the documentation-url branch from a4c7309 to 4f67e9d Compare February 17, 2025 19:38
@nikku nikku force-pushed the documentation-url branch from 4f67e9d to a3bac51 Compare February 17, 2025 19:44
@@ -28,53 +28,43 @@ RuleTester.verify('link-event', rule, {
report: [
{
'id': 'THROW_NO_NAME',
'message': 'Link event is missing name',
'category': 'error'
'message': 'Link event is missing name'
Copy link
Member

Choose a reason for hiding this comment

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

Is it expected that the category is gone?

Copy link
Member

Choose a reason for hiding this comment

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

OK I see the commit message

@barmac barmac merged commit 6152581 into main Feb 18, 2025
7 of 9 checks passed
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Feb 18, 2025
@barmac barmac deleted the documentation-url branch February 18, 2025 13:40
@nikku
Copy link
Member Author

nikku commented Feb 18, 2025

Released with v11.2.0

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.

Ship documentation URLs with lint rules
2 participants