Request for gitParameter plugin FULL documentation

Hello,

Can you please give a link somewhere to gitParameter plugin FULL documentation, if it exists.

I have been looking on Jenkins and gitHub but I cannot find an exhaustive documentation for this plugin, that is to say : a documentation describing all available parameters, with their full syntax and possible values.

As an example, I cannot find sufficient information on ‘branchFilter’ parameter.

When I use gitParameter in such a way in my declarative pipelines :

gitParameter(name: ‘BRANCH_NAME’,
type: ‘PT_BRANCH’,
branchFilter: “************”,
description: ‘Select branch’
)

I want to know exacly what I can use in ‘branchFilter’ value, is it a regex ?

What if I want to list all branches except the ones maching a pattern ?

I tried using regex value :

“^((?!origin/main).)”

which does not work. And without a full documentation, I have no way to know if I my regex is wrong, not adapted to plugin or if plugin simply does not support regex.

This is just an example, and I frequently had issues finding detailed documentation on several of the plugin parameters. Is there a secret website with full documentation I could not find.

More generaly speeking, I am experiencing same issues finding detailed documentation for several Jenkins plugins.

Thank you for your help

This here is your documentation: GitHub - jenkinsci/git-parameter-plugin: Jenkins plugin for chosing Revision / Tag before build

Unfortunately, using this requires that you know how to read Java because it’s all source.

Now, you can also use the Pipeline Syntax link on any job page on your Jenkins Controller to help you build the pipeline call. On there, you’ll be able to find the detail for branchFilter which displays the contents of this file: git-parameter-plugin/src/main/resources/net/uaznia/lukanus/hudson/plugins/gitparameter/GitParameterDefinition/help-branchFilter.html at d43f48837b9ed17213f48ed326836dc66ca26d90 · jenkinsci/git-parameter-plugin · GitHub

1 Like

Thanks for the additional links.

Do you know how branchFilter can be set to list all branches except ‘origin/main’ ?