Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-75348

Request for gitParameter plugin FULL documentation

XMLWordPrintable

    • Icon: New Feature New Feature
    • Resolution: Fixed
    • Icon: Minor Minor
    • git-parameter-plugin
    • None

      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

       

            klimas7 Boguslaw Klimas
            yanickno Yanick
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: