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

JobDSL should hide deprecated properties in API viewer

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Minor Minor
    • job-dsl-plugin
    • None

      The job DSL API Viewer is a good starting point in order to create an initial job setup. Currently the API viewer shows all available @DataBound properties of Jenkins classes. It would make sense, if the API Viewer would only show those properties which are not marked as @Deprectated. Otherwise users learn an API which will be removed some time in the future.

      Example from recordIssues (IssuesRecorder):

      recordIssues {
      // By default, each static analysis result will be recorded as a separate result that is presented as an individual Jenkins Action with separate UI and dashboard.
      aggregatingResults(boolean value)
      // If there is more than one static analysis result available then an aggregation trend chart will be shown on the project page that shows the analysis results in a single trend chart.
      aggregationTrend(String value)
      // If this option is unchecked, then the plugin automatically shows what revision and author (name and email) last modified the lines of the affected files that contain issues.
      blameDisabled(boolean value)
      // By default, static analysis results are only recorded for stable or unstable builds, but not for failed builds: analysis results might be inaccurate if the build failed.
      enabledForFailure(boolean value)
      // If there are errors while scanning the console log or files for issues (e.g., file pattern matches no files, source files could not be copied, etc.) then the warning plugin will show these errors in a separate view but does not alter the build state.
      failOnError(boolean value)
      
      // The next two properties are deprecated:
      failedNewAll(int value)
      failedNewHigh(int value)
      
      ...
      

            jamietanna Jamie Tanna
            drulli Ulli Hafner
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: