opendev/gerrit
Code Issues Proposed changes
737285df3f
gerrit/Documentation
History
Luca Milanesio 737285df3f Allow plugins to contribute InitStep to Gerrit init. 
Plugin has to include a class that implements
com.google.gerrit.pgm.init.InitStep and specifying
the class name into the Plugin MANIFEST.MF.

Plugin InitStep is getting instantiated using the
Gerrit PGM injector and then is able to access
the same init objects.

Example:
--------
public class InitJira implements InitStep {
  private ConsoleUI ui;

  @Inject
  public InitJira(final ConsoleUI ui, final Section.Factory sections) {
    this.ui = ui;
    this.sections = sections;
  }

  @Override
  public void run() throws Exception {
    ui.header("Jira integration");
    // Jira-specific init steps.

    Section jira = sections.get("link", "jira");
    // Jira-specific link expansions
  }
}

MANIFEST.MF:
------------
Gerrit-InitStep: com.googlesource.plugins.jira.InitJira

Change-Id: I84fcb9acd6845c706961657219a14570e2060b0f
Signed-off-by: Luca Milanesio <luca.milanesio@gmail.com>
2012-10-22 10:07:31 -07:00
..
images First Cut of Gerrit Walkthrough Introduction documentation. 2011-12-28 12:33:39 -07:00
.gitignore Move documentation to gerrit.googlecode.com website 2009-01-29 08:53:07 -08:00
access-control.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
asciidoc.conf Put a link back to the index in every page footer 2009-05-28 15:55:01 -07:00
cmd-ban-commit.txt Add SSH command to ban commits 2012-03-30 16:12:42 +02:00
cmd-cherry-pick.txt Specify output file for curl commands in documentation 2012-07-09 11:34:59 +02:00
cmd-create-account.txt Update HTTP password from SSH commands. 2012-09-13 09:15:02 +02:00
cmd-create-group.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-create-project.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-flush-caches.txt Access control documentation: Flush caches capability 2012-03-21 17:43:29 +01:00
cmd-gsql.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
cmd-hook-commit-msg.txt Documentation: commit message hook file should be executable 2012-08-17 09:46:38 +02:00
cmd-index.txt Add ssh command "test-submit-rule" 2012-10-10 15:34:34 +02:00
cmd-kill.txt Access control documentation: Kill and priority capabilities 2012-03-21 17:43:29 +01:00
cmd-ls-groups.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-ls-projects.txt ls-projects: Add option to list projects on which a certain group is used 2012-08-31 15:53:04 +02:00
cmd-plugin-enable.txt Add ssh command to enable plugins 2012-07-26 16:24:47 -05:00
cmd-plugin-install.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-plugin-ls.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-plugin-reload.txt Document that on reload of a plugin a new plugin configuration gets active 2012-07-18 12:48:36 +02:00
cmd-plugin-remove.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-query.txt Add author and size information to output of query. 2012-10-11 16:03:39 +02:00
cmd-receive-pack.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-rename-group.txt Add new SSH command to rename groups 2011-10-27 00:28:11 +02:00
cmd-review.txt cmd-review.txt: Add clarification in documentation of --force-message 2012-07-24 13:17:47 +02:00
cmd-set-account.txt Update HTTP password from SSH commands. 2012-09-13 09:15:02 +02:00
cmd-set-project-parent.txt Support to reparent all children of a parent project 2011-11-16 09:34:26 +01:00
cmd-set-project.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-set-reviewers.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-show-caches.txt Fix link in show caches documentation 2012-03-26 13:23:12 +02:00
cmd-show-connections.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-show-queue.txt Access control documentation: Capability view conn. & queue 2012-03-28 17:34:33 +02:00
cmd-stream-events.txt Send event to stream and execute hook when merge fails 2012-10-17 17:34:14 +09:00
cmd-suexec.txt documentation: Clean up command line documentation, examples 2011-06-14 16:50:19 -07:00
cmd-test-submit-rule.txt Add ssh command "test-submit-rule" 2012-10-10 15:34:34 +02:00
cmd-version.txt Add missing documentation of SSH "version" command 2012-09-25 12:26:52 -04:00
config-contact.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-gerrit.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
config-gitweb.txt Gitweb Instruction Updates 2012-08-01 16:55:37 -04:00
config-headerfooter.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-hooks.txt Send event to stream and execute hook when merge fails 2012-10-17 17:34:14 +09:00
config-mail.txt Add email footer token to identify if inline comments are present 2012-10-18 11:50:04 +09:00
config-reverseproxy.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-sso.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
dev-contributing.txt Documentation: Various typo corrections 2012-05-09 13:21:35 -04:00
dev-design.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
dev-eclipse.txt Complete Gerrit 2.5 release notes 2012-07-30 13:32:30 +02:00
dev-plugins.txt Allow plugins to contribute InitStep to Gerrit init. 2012-10-22 10:07:31 -07:00
dev-readme.txt Update top level SUBMITTING_PATCHES 2012-02-13 23:34:50 -08:00
dev-release-deploy-config.txt Improve release documentation 2012-09-03 14:11:12 +02:00
dev-release-subproject.txt Improve release documentation 2012-09-03 14:11:12 +02:00
dev-release.txt Improve release documentation 2012-09-03 14:11:12 +02:00
error-branch-not-found.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-closed.txt Add documentation of "change closed" error when using ssh review 2012-06-27 10:10:23 +02:00
error-change-does-not-belong-to-project.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-not-found.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-upload-blocked.txt Added explanation for "One or more refs/for/ ..." error 2011-02-03 08:53:46 +01:00
error-contains-banned-commit.txt Added explanation for "contains banned commit" error 2011-04-08 11:00:40 +02:00
error-has-duplicates.txt Added explanation for "... has duplicates" error 2011-03-10 13:17:36 +01:00
error-invalid-author.txt Correct documentation of "invalid author/committer" errors 2012-06-26 09:24:47 +02:00
error-invalid-changeid-line.txt added explanation for "invalid Change-Id" error 2010-12-29 08:25:40 +01:00
error-invalid-committer.txt Correct documentation of "invalid author/committer" errors 2012-06-26 09:24:47 +02:00
error-messages.txt Documentation: list error messages in alphabetical order 2012-07-06 12:50:35 +02:00
error-missing-changeid.txt Fix formatting issues in error documentation 2011-05-06 10:32:05 +02:00
error-multiple-changeid-lines.txt added explanation for "multiple Change-Id lines" error 2010-12-29 08:04:14 +01:00
error-no-changes-made.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-no-common-ancestry.txt Added explanation for "no common ancestry" error 2011-01-25 15:33:40 +01:00
error-no-new-changes.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-non-fast-forward.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-a-gerrit-administrator.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-a-gerrit-project.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-allowed-to-upload-merges.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-permitted-to-create.txt Added explanation for "Not permitted to create" error 2011-02-04 10:22:50 +01:00
error-not-signed-off-by.txt Access control documentation: Forge identity 2012-01-20 17:20:25 +01:00
error-not-valid-ref.txt Added explanation for "not valid ref" error 2011-01-12 07:12:36 -08:00
error-permission-denied.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-prohibited-by-gerrit.txt Fix message if pushing tag is rejected because tagger is somebody else 2012-09-17 08:59:10 +02:00
error-push-fails-due-to-commit-message.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-squash-commits-first.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-upload-denied.txt Access control documentation: Read and Submit 2012-01-23 16:46:57 +01:00
GEN-DOC-VERSION documentation: Fix version number to only consider x.y.z format 2010-02-22 14:14:53 -08:00
i18n-readme.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
index.txt Write a Cookbook for Prolog submit rules 2012-09-17 09:13:11 +02:00
install-j2ee.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
install-quick.txt install-quick.txt: Add some clarifications to help new users 2012-06-18 10:25:34 +02:00
install.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
intro-quick.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
json.txt Merge branch 'stable-2.5' 2012-10-16 12:13:32 -07:00
licenses.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
Makefile Make sure asciidoc uses unix line endings in generated HTML. 2012-06-27 10:19:13 +02:00
pgm-daemon.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
pgm-ExportReviewNotes.txt Documentation: Add documentation of refs/notes/review 2012-07-30 14:07:36 +02:00
pgm-gsql.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
pgm-index.txt Enable case insensitive login to Gerrit WebUI for LDAP authentication 2011-10-26 23:01:57 +02:00
pgm-init.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
pgm-LocalUsernamesToLowerCase.txt Enable case insensitive login to Gerrit WebUI for LDAP authentication 2011-10-26 23:01:57 +02:00
pgm-prolog-shell.txt prolog-shell: Simple command line Prolog interpreter 2011-06-21 14:15:53 -07:00
pgm-rulec.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
pgm-ScanTrackingIds.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
project-setup.txt Add submit strategy that rebases the change if necessary 2012-10-21 11:31:02 -07:00
prolog-change-facts.txt Write a Cookbook for Prolog submit rules 2012-09-17 09:13:11 +02:00
prolog-cookbook.txt Describe submit filter in the prolog-cookbook. 2012-09-17 09:13:22 +02:00
refs-notes-review.txt Documentation: Add documentation of refs/notes/review 2012-07-30 14:07:36 +02:00
rest-api.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
user-changeid.txt Document execute permission for commit-msg in Change-Id docs 2012-10-03 19:16:05 -04:00
user-custom-dashboards.txt Document custom dashboards 2012-07-19 12:37:25 +02:00
user-notify.txt Add notify section in project.config 2012-05-09 07:11:09 -07:00
user-search.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
user-signedoffby.txt documentation: Clean up references to 'Gerrit2' 2009-12-11 17:43:39 -08:00
user-submodules.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
user-upload.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00