Skip to content

Add instruction for building the plugin for different environments - #69

Merged
Tsyklop merged 2 commits into
mainfrom
docs/build-instruction
Nov 6, 2026
Merged

Tsyklop merged 2 commits into
mainfrom
docs/build-instruction

Conversation

@Tsyklop

@Tsyklop Tsyklop commented Nov 6, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Adds documentation/BuildingPlugin.md, which covers how to build one or all environments (252–263), the build options, checking and installing a build, and common failures.
  • Corrects CONTRIBUTING.md: the required Java version is 21, not 17, and the zip is written to intellij-plugin/build/distributions, not build/distributions. It now links to the new doc.

Documentation only: no code or build changes.

Verification

Run on this branch in a worktree that no other build was using:

  • buildPlugin passes for 252, 253, 261, 262 and 263. In each zip, the version and build range in plugin.xml match its environment.
  • buildPlugin -PbaseIDE=clion on 261, run straight after 263, also produces correct metadata.
  • verifyPlugin on 261 reports the plugin as compatible.
  • An invalid environmentName fails with the message the doc quotes.
  • The PowerShell loop stops at the first failure (tested with help instead of buildPlugin), and an unquoted -PpluginVersion=2026.22.1 does split at the dot.

Not run: the run* tasks, installing a zip in an IDE, and baseIDE=pycharm or baseIDE=rider.

An earlier test run in a checkout shared with other builds produced a zip named for 2026.1 that contained the plugin.xml of 2026.3. It didn't reproduce in isolation, so the doc now warns against overlapping builds.

CI

"Check the plugin for 262" passes. "Check the plugin for 261" failed with "The self-hosted runner lost communication with the server", the problem addressed by #67, which isn't on main yet. This PR changes only documentation.

For reviewers

publish.yaml builds and publishes only 252, 253 and 261, so CI doesn't publish 262 or 263. The doc describes this as it stands today. I can't tell whether it's intentional, so it may need its own change.

Also correct the required Java version and the distribution path in CONTRIBUTING.md.
Add a warning about overlapping builds and the way to build in a separate worktree, use the real error messages in troubleshooting, and state the expected disk use and build time.
@Tsyklop
Tsyklop merged commit e8e35db into main Nov 6, 2026
1 of 2 checks passed
@Tsyklop
Tsyklop deleted the docs/build-instruction branch November 6, 2026 15:48
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.

1 participant