Move Jenkins Setup section back to README #53
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change-Id: I963456df3b57bd82a589156495c8092bbb625091
Change-Id: I1cf9e902424c6d072516a093a9e1c0e284b40f62
This way the most important information, that is how to use it is right in the README. Previously possible user woudl have to somehow guess that user guide is inside BUILD.md:)
Issues moved above Plugin Releases, to make it easier to find. "Integrating with the Gerrit Checks plugin" section moved to "Jenkins Setup" from "Why a new name?". Also fixed header level for Issues and Plugin Releases, it should be h2, that is section title, not h1, that is page title. Also changes some header levels
lucamilanesio
force-pushed
the
master
branch
from
c2dc7a7 to
3b2fab3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It took me hours to finally find how to set up this plugin. And only afterwards I managed to find the
Build.mdfile with exact instructions I needed. I believe those instructions should be directly in README so it will be easy to find them, both on GitHub and on Jenkins Plugins site.BTW. I have two questions about things I also could update README with:
I am still not sure what the "Using Gerrit Trigger Plugin" section is about. Is is about using Gerrit Trigger plugin for everything, except that instead of voting via it, you vote using the pipeline steps that Gerrit Code Review plugin provides? Or it is about using multi-branch pipeline with Gerrit Code Review plugin, adding Gerrit Trigger only as as triggering mechanism instead of Gerrit WebHook plugin.
Is Gerrit git-refs-filter still needed? Especially if not using Gerrit checks plugin? Also why any of those solutions are needed? WebHook plugin probably provides all required information, so there is no need to scan all internal Gerrit branches?