opendev/gerrit
Code Issues Proposed changes

Document how to bundle custom plugins in release.war

Browse Source 
Change-Id: I220e56972912e99403461016f4b5c7a6ea5c21f5
This commit is contained in:
Sven Selberg 2017-12-21 15:24:29 +01:00
parent e9897ddc24
commit 6da8b4e824
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Documentation/dev-build-plugins.txt
View File

@ -95,6 +95,38 @@ def external_plugin_deps():
)
----
=== Bundle custom plugin in release.war ===
To bundle custom plugin(s) in the link:dev-bazel.html#release[release.war] artifact,
add them to the CUSTOM_PLUGINS list in `tools/bzl/plugins.bzl`.
Example of `tools/bzl/plugins.bzl` with custom plugin `my-plugin`:
----
CORE_PLUGINS = [
"commit-message-length-validator",
"download-commands",
"hooks",
"replication",
"reviewnotes",
"singleusergroup",
]
CUSTOM_PLUGINS = [
"my-plugin",
]
CUSTOM_PLUGINS_TEST_DEPS = [
# Add custom core plugins with tests deps here
]
----
[NOTE]
Since `tools/bzl/plugins.bzl` is part of Gerrit's source code and the version
of the war is based on the state of the git repository that is built; you should
commit this change before building, otherwise the version will be marked as
'dirty'.
== Bazel standalone driven
Only few plugins support that mode for now: