Remove deprecated code #1652

uhafner · 2024-01-10T08:41:46Z

Remove all deprecated methods and fields.

Based on #1649.

# Conflicts: # plugin/pom.xml # plugin/src/main/java/io/jenkins/plugins/analysis/core/steps/RecordIssuesStep.java # plugin/src/main/java/io/jenkins/plugins/analysis/core/steps/ScanForIssuesStep.java # plugin/src/test/java/io/jenkins/plugins/analysis/warnings/steps/MiscIssuesRecorderITest.java # plugin/src/test/java/io/jenkins/plugins/analysis/warnings/steps/StepsITest.java

plugin/src/test/java/io/jenkins/plugins/analysis/core/util/QualityGateTest.java

 import static org.mockito.Mockito.*;

 /**
 * Tests the class {@link QualityGate}.
 *
 * @author Ullrich Hafner
 */
-class QualityGateTest extends SerializableTest<QualityGate> {
+class QualityGateTest extends SerializableTest<WarningsQualityGate> {


KalleOlaviNiemitalo · 2024-02-27T08:32:05Z

I'll need to replace deprecated parameters of pipeline steps in multiple repositories and branches before I can safely upgrade warnings-ng-plugin from 10.7.0 to 11.0.0 in production. Is there a summary list of the required changes? I attempted to make one below.

publishIssues step (io.jenkins.plugins.analysis.core.steps.PublishIssuesStep):
- ignoreFailedBuilds parameter: Deleted, although it had not been @Deprecated.
- referenceBuildId parameter: Deleted, although it had not been @Deprecated.
- referenceJobName parameter: Deleted, although it had not been @Deprecated.
- unstableTotalAll, unstableTotalHigh, unstableNewAll, unstableTotalNormal, unstableTotalLow, unstableNewHigh, unstableNewNormal, unstableNewLow, failedTotalAll, failedTotalHigh, failedTotalNormal, failedTotalLow, failedNewAll, failedNewHigh, failedNewNormal, failedNewLow parameters: Replaced with qualityGates.
recordIssues step (io.jenkins.plugins.analysis.core.steps.RecordIssuesStep):
- blameDisabled parameter: Replaced with skipBlames.
- forensicsDisabled parameter: Deleted.
- ignoreFailedBuilds parameter: Deleted, although it had not been @Deprecated.
- referenceBuildId parameter: Deleted, although it had not been @Deprecated.
- referenceJobName parameter: Deleted, although it had not been @Deprecated.
- sourceDirectory parameter: Replaced with sourceDirectories, although it had not been @Deprecated.
- unstableTotalAll, unstableTotalHigh, unstableNewAll, unstableTotalNormal, unstableTotalLow, unstableNewHigh, unstableNewNormal, unstableNewLow, failedTotalAll, failedTotalHigh, failedTotalNormal, failedTotalLow, failedNewAll, failedNewHigh, failedNewNormal, failedNewLow parameters: Replaced with qualityGates.
scanForIssues step (io.jenkins.plugins.analysis.core.steps.ScanForIssuesStep):
- forensicsDisabled parameter: Deleted.
- sourceDirectory parameter: Replaced with sourceDirectories, although it had not been @Deprecated.
(This step still has a blameDisabled parameter rather than a skipBlames parameter. That will be changed in Use the correct property name skipBlames #1690.)
For freestyle jobs (io.jenkins.plugins.analysis.core.steps.IssuesRecorder):
- forensicsDisabled parameter: Deleted.
- sourceDirectory parameter: Replaced with sourceDirectories, although it had not been @Deprecated.
- ignoreFailedBuilds parameter: Deleted, although it had not been @Deprecated.
- referenceJobName parameter: Deleted, although it had not been @Deprecated.
- referenceBuildId was also removed but it did not have @DataBoundSetter.
- publishAllIssues parameter: Replaced with checksAnnotationScope, although it had not been @Deprecated. If it is deserialized from a previously saved job, it will be translated to checksAnnotationScope.

Step parameters newly deprecated in 11.0.0:

publishIssues step (io.jenkins.plugins.analysis.core.steps.PublishIssuesStep),
recordIssues step (io.jenkins.plugins.analysis.core.steps.RecordIssuesStep):
- publishAllIssues parameter: Deprecated; use checksAnnotationScope.
- qualityGates parameter:
  - unstable property: Deprecated; use criticality.

uhafner · 2024-02-27T09:25:33Z

Thanks for collecting this information! I think you found all changes. I added these steps to the release notes!

sach-edna · 2024-03-13T07:52:28Z

Hi, thanks for documenting these changes. Please excuse my ignorance of this information, but is there some place these changes are documented beforehand or for the future?

We use the warnings-ng plugin for taskscanner, parasoft, pylint, iar, gcc, cmaken, mypy in about 50 pipeline projects. When updating the warnings-ng plugin we got an syntax error across most of our pipelines. Is there some way we could have known this was coming (except monitoring the PR's and commits in this repo)?

Since we will have to update most of our pipelines, it would be nice if we could have an idea which breaking syntax changes are coming, to plan our maintenance accordingly.

Thanks for your hard work in maintaining this plugin!

uhafner · 2024-03-13T09:21:42Z

Hi, thanks for documenting these changes. Please excuse my ignorance of this information, but is there some place these changes are documented beforehand or for the future?

We use the warnings-ng plugin for taskscanner, parasoft, pylint, iar, gcc, cmaken, mypy in about 50 pipeline projects. When updating the warnings-ng plugin we got an syntax error across most of our pipelines. Is there some way we could have known this was coming (except monitoring the PR's and commits in this repo)?

Since we will have to update most of our pipelines, it would be nice if we could have an idea which breaking syntax changes are coming, to plan our maintenance accordingly.

Thanks for your hard work in maintaining this plugin!

The required changes are typically part of the release notes (https://github.com/jenkinsci/warnings-ng-plugin/releases/tag/v11.0.0) or the pull request. Most removed attributes have been marked as deprecated for quite a while. So it makes sense to check these before doing a major version upgrade.

For some of the properties it wasn't possible to leave the property in place as I moved the functionality to a different plugin.

sach-edna · 2024-03-13T09:26:43Z

Thanks for this information. We will keep in mind to check the release notes for further changes. Do you have a plan/roadmap for future syntax changes? Since we have to update quite a few of them it would be helpful to know is new changes will be coming soon. If not we will update to the new syntax, otherwise we will wait a bit until the new syntax is added.

uhafner · 2024-03-13T09:32:48Z

Thanks for this information. We will keep in mind to check the release notes for further changes. Do you have a plan/roadmap for future syntax changes? Since we have to update quite a few of them it would be helpful to know is new changes will be coming soon. If not we will update to the new syntax, otherwise we will wait a bit until the new syntax is added.

There are no major upgrades planned in the near future since my research semester is finished I am back to my normal schedule which doesn't allow to make bigger changes...

KalleOlaviNiemitalo · 2024-03-13T10:00:26Z

When I was collecting data for #1652 (comment), I hoped Jenkins could be made to automatically warn about uses of deprecated parameters in pipelines; either as part of Pipeline itself, or as a separate plugin. Alas, several of the removed parameters had not been deprecated, so it would not have been possible to warn about them.

sunnypatel2141 · 2024-06-25T14:32:12Z

Hi
Why was referenceJobName deleted? Is there an alternate to this ?

uhafner · 2024-06-25T14:47:48Z

Yes, you need to use the reference recorder step. See forensics api plugin.

sunnypatel2141 · 2024-06-25T14:53:59Z

Thanks.
Can you tell how we can convert

           recordIssues qualityGates: [
             [threshold: 1, type: 'TOTAL_HIGH', unstable: true], 
             [threshold: 1, type: 'TOTAL_NORMAL', unstable: true], 
             [threshold: 1, type: 'TOTAL_LOW', unstable: true], 
             [threshold: 6, type: 'TOTAL_HIGH', unstable: false], 
             [threshold: 6, type: 'TOTAL_NORMAL', unstable: false], 
             [threshold: 6, type: 'TOTAL_LOW', unstable: false]
             ], 
             referenceJobName: '/Lego/lego-pipeline/build/lego-multibranch/master',
             tools: [findBugs(pattern: '**/reports/spotbugs/*.xml', useRankAsPriority: true)]

This to use two plugins now ? recordIssues + discoverReferenceBuild. An example would really help. Thanks.

uhafner · 2024-06-25T20:11:41Z

See https://github.com/jenkinsci/warnings-ng-plugin/blob/main/doc/Documentation.md#configure-the-selection-of-the-reference-build-baseline

maciejmatczak · 2024-11-07T09:23:03Z

Hello. Got here by a long journey - from failing pipelines. Disappearing ignoreFailedBuilds brought me here. Docs of 11.10.0 still mentions it as a go-to solution: https://github.com/search?q=repo%3Ajenkinsci%2Fwarnings-ng-plugin%20ignoreFailedBuilds&type=code.

It's hard to me to realize what's the proper migration flow after this deprecation, any help appreciated.

KalleOlaviNiemitalo · 2024-11-07T14:58:00Z

@maciejmatczak, did you look at the "Upgrade path" in https://github.com/jenkinsci/warnings-ng-plugin/releases/tag/v11.0.0?

uhafner added 18 commits December 30, 2023 00:19

[JENKINS-72059] Add new quality gate options to alter the stage only.

8c97e58

Fix some tests.

afb3d2a

Make API method of quality result accessible.

69d72f5

Fix reference of old quality gate status.

58afecf

Fix quality gate definition in Job DSL.

0ec09b2

Fix quality gates in remote API.

1b37074

Add integer based setter fpr threshold.

b840867

Add integer based setter for threshold.

a8614a1

Fix new quality gates in UI test.

9ddcf8c

Fix enum values.

e998875

Fix enum values for pipelines.

fbe68be

Add integer based threshold.

96a63ca

Add integer based threshold to quality gate.

7c345c7

Add an integer-based threshold for quality gates.

d1f0abe

Fix order in assertion.

96f31be

Use new data-bound properties of QualityGate.

6290cee

Use new output of snippet generator.

f7a00f8

Remove deprecated code.

33ce1b8

uhafner added the breaking Breaking Changes label Jan 10, 2024

github-advanced-security bot found potential problems Jan 12, 2024

View reviewed changes

uhafner added 6 commits January 12, 2024 17:10

Remove global configuration of source paths.

cc2f21e

Remove source directory.

d1fad88

Remove source directory.

e4b3c2f

Restore totals field when null.

c9e0b4a

Remove test for old serialization.

16139ca

Use lineRange from codingstyle.

2d098bd

uhafner merged commit 58782cc into main Feb 23, 2024
2 of 4 checks passed

uhafner deleted the remove-deprecated branch February 23, 2024 22:34

smerle33 mentioned this pull request Mar 4, 2024

Bump Jenkins Weekly docker image version on infra.ci.jenkins.io to 1.32.0-2.448 jenkins-infra/kubernetes-management#5033

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove deprecated code #1652

Remove deprecated code #1652

uhafner commented Jan 10, 2024

KalleOlaviNiemitalo commented Feb 27, 2024 •

edited

Loading

uhafner commented Feb 27, 2024

sach-edna commented Mar 13, 2024

uhafner commented Mar 13, 2024

sach-edna commented Mar 13, 2024 via email •

edited

Loading

uhafner commented Mar 13, 2024

KalleOlaviNiemitalo commented Mar 13, 2024

sunnypatel2141 commented Jun 25, 2024 •

edited

Loading

uhafner commented Jun 25, 2024

sunnypatel2141 commented Jun 25, 2024

uhafner commented Jun 25, 2024

maciejmatczak commented Nov 7, 2024

KalleOlaviNiemitalo commented Nov 7, 2024

Remove deprecated code #1652

Remove deprecated code #1652

Conversation

uhafner commented Jan 10, 2024

KalleOlaviNiemitalo commented Feb 27, 2024 • edited Loading

uhafner commented Feb 27, 2024

sach-edna commented Mar 13, 2024

uhafner commented Mar 13, 2024

sach-edna commented Mar 13, 2024 via email • edited Loading

uhafner commented Mar 13, 2024

KalleOlaviNiemitalo commented Mar 13, 2024

sunnypatel2141 commented Jun 25, 2024 • edited Loading

uhafner commented Jun 25, 2024

sunnypatel2141 commented Jun 25, 2024

uhafner commented Jun 25, 2024

maciejmatczak commented Nov 7, 2024

KalleOlaviNiemitalo commented Nov 7, 2024

KalleOlaviNiemitalo commented Feb 27, 2024 •

edited

Loading

sach-edna commented Mar 13, 2024 via email •

edited

Loading

sunnypatel2141 commented Jun 25, 2024 •

edited

Loading