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

Missing documentation on parameters of ${LOG_REGEX} token

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open (View Workflow)
    • Priority: Blocker
    • Resolution: Unresolved
    • Component/s: email-ext-plugin
    • Labels:
      None
    • Environment:
      Jenkins 2.263.3
    • Similar Issues:

      Description

      When I click on the "?" (question mark) associated with the Content Token Reference in the Editable Email Notification section of the Jenkins project configuration page, I see the following documentation of the ${LOG_REGEX} token:

      ${LOG_REGEX}
      Uses a regular expression to find a single log entry and generates a new output using the capture groups from it. This is partially based on the description-setter plugin (https://github.com/jenkinsci/description-setter-plugin).

      That's missing any explanation of how to specify the regex and the new output.

      Without knowing how to specify those, the token is unusable.

        Attachments

          Activity

          Hide
          ben_g Ben Gottesman added a comment -

          Note: I determined through trial and error that the parameter names are regex and replacement.

          Show
          ben_g Ben Gottesman added a comment - Note: I determined through trial and error that the parameter names are  regex  and  replacement .
          Hide
          basil Basil Crow added a comment -

          Thanks for reporting this, Ben Gottesman. Would you be willing to open a pull request improving the documentation? This way others in the future would be able to benefit from your experience.

          Show
          basil Basil Crow added a comment - Thanks for reporting this, Ben Gottesman . Would you be willing to open a pull request improving the documentation? This way others in the future would be able to benefit from your experience.

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            ben_g Ben Gottesman
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated: