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

Warn about paid plugin running buildSearchableOptions and suggest [disabling the task](https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin-faq.html#how-to-disable-building-searchable-options). #1025

Merged
merged 1 commit into from
Jun 16, 2022

Conversation

hsz
Copy link
Member

@hsz hsz commented Jun 15, 2022

Pull Request Details

Warn about paid plugin running buildSearchableOptions and suggest disabling the task.

Description

Due to IDE limitations, it is impossible to run the IDE in headless mode to collect searchable options for a paid plugin. As paid plugins require providing a valid license and presenting a UI dialog, it is impossible to handle such a case, and the task will fail. This feature flag displays the given warning when the task is run by a paid plugin.

Such a warning can be disabled using build features:

org.jetbrains.intellij.buildFeature.paidPluginSearchableOptionsWarning = false

Motivation and Context

Warn paid plugin developers about the buildSearchableOptions in advance.

How Has This Been Tested

Manual + integration tests:

  • free plugin running the task – nothing happens
  • paid plugin with <product-descriptor> defined in the plugin.xml file – emit warning

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have included my change in the CHANGELOG.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@hsz hsz added this to the next milestone Jun 15, 2022
@hsz hsz self-assigned this Jun 15, 2022
@hsz hsz merged commit 9bf8b94 into master Jun 16, 2022
@hsz hsz deleted the paid_plugin_searchable_options_warning branch June 16, 2022 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant