Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 243854 - Create API report for changes compared to last release during builds
Summary: Create API report for changes compared to last release during builds
Status: CLOSED WONTFIX
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Releng (show other bugs)
Version: 3.5   Edit
Hardware: PC Windows XP
: P2 normal (vote)
Target Milestone: ---   Edit
Assignee: Sravan Kumar Lakkimsetti CLA
QA Contact:
URL:
Whiteboard: stalebug
Keywords:
: 409949 (view as bug list)
Depends on: 258853
Blocks:
  Show dependency tree
 
Reported: 2008-08-12 05:35 EDT by Markus Keller CLA
Modified: 2020-11-24 01:31 EST (History)
10 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Markus Keller CLA 2008-08-12 05:35:16 EDT
(In reply to bug 243548 comment #3)
> (In reply to bug 243548 comment #2)
> > Wouldn't it be interesting to have a report of API changes w.r.t. the last
> > release also during the milestones? Especially in 3.5M5, it would be
> > interesting to see what APIs have been added (maybe accidentally).
> 
> You should enter a new feature request for this in PDE API/Tooling - I also
> think it would be interesting to have tooling/reports for API additions/changes
> since the last release.

I guess most of this is already there, see e.g. the report for 3.4RC4:
http://archive.eclipse.org/eclipse/downloads/drops/S-3.4RC4-200806091311/apitools/report.html

Should just get
- a better title: Not "Unapproved", but something like "API Changes compared to R-3.4-200806172000"
- a list of checked plug-ins without API changes
- a list of plug-ins that have not been checked, like the link at the top of http://archive.eclipse.org/eclipse/downloads/drops/S-3.4RC4-200806091311/apitools/apitoolsverifications/html/index.html
Comment 1 Markus Keller CLA 2009-03-08 05:49:52 EDT
Right now, shortly before M6, this would be very interesting again.
Comment 2 Darin Wright CLA 2009-03-09 13:00:59 EDT
We plan to turn on "API Freeze" reporting post M6 (to discover unapproved/accidental API changes). This week, I don't want to add to the risk of causing build headaches (by introducing new reports). If there is a specific report you'd like, we could probably create one manually.
Comment 3 Markus Keller CLA 2009-03-12 07:36:58 EDT
> We plan to turn on "API Freeze" reporting post M6 (to discover
> unapproved/accidental API changes).

That's also interesting, but this bug requests something else: I'd like to see the changes compared to the last stable build. This should be a separate report from the "API Freeze" report, and it should be available during the whole development cycle. So after the API freeze, there should be 2 reports.
Comment 4 Olivier Thomann CLA 2009-03-12 10:19:48 EDT
I think this is more related to bug 258853.
We plan to add a way to get a compare report vs a baseline you can choose.

Would this meet your needs? If yes, I would close this one as a dup of bug 258853.
Comment 5 Markus Keller CLA 2009-03-12 11:43:06 EDT
Yes, sounds like the generated html report from bug 258853 would solve this. I would keep bug 258853 for the implementation and this bug for actually getting it into the SDK build results.
Comment 6 Markus Keller CLA 2013-06-05 08:16:16 EDT
Now that bug 258853 is fixed, I think this bug can be moved to Platform/Releng to eventually generate the report for all builds.
Comment 7 Dani Megert CLA 2013-06-05 08:23:11 EDT
*** Bug 409949 has been marked as a duplicate of this bug. ***
Comment 8 David Williams CLA 2013-06-25 10:06:32 EDT
Just happened across this old bug. 

IMHO, it's overkill to have a report comparing API to most recent I-build, or even most recent S-build ... very limited audience. 

In other words, I'd like to close as "won't fix" ... but ... if you still feel important, please clarify the rationale why it is worth the time and effort and exactly who audience reader is. 

Thanks,
Comment 9 Dani Megert CLA 2013-06-25 10:36:31 EDT
(In reply to comment #8)
> Just happened across this old bug. 
> 
> IMHO, it's overkill to have a report comparing API to most recent I-build,
> or even most recent S-build ... very limited audience. 

Yes, this would be useless. However, that's not what this bug asks for. It asks to compare the build with the last official RELEASE. Most useful will be the report for the very last build of a cycle as it will list all the API changes compared to the previous release.
Comment 10 Markus Keller CLA 2013-06-25 10:55:20 EDT
And before the API freeze, committers, contributors, and consumers could sanity check the planned API changes (which are cast in stone after the release, since our policy is not to break APIs).
Comment 11 David Williams CLA 2013-06-25 11:52:15 EDT
Ok ... and so taking this opportunity to really show off my ignorance ... how is this different than the report(s) we currently generate?
Comment 12 Markus Keller CLA 2013-06-25 12:11:21 EDT
See comment 0: It's just about using the right baseline and fixing a few descriptions, so that it's not a "freeze" report, but a "change" report.

Currently (i.e. in http://download.eclipse.org/eclipse/downloads/drops4/I20130618-0800/testResults.php ), there's no such report, but 4.3 RC4 contains the "API Tools Post-API Freeze Report" that contains all the information we're looking for: http://download.eclipse.org/eclipse/downloads/drops4/S-4.3RC4-201306052000/apitools/freeze_report.html
Comment 13 David Williams CLA 2013-06-25 12:21:09 EDT
Ok, thanks. I think I "get it" now.
Comment 14 Markus Keller CLA 2015-01-16 11:17:18 EST
Would be nice to have API change reports enabled before the API freeze (M6).
Comment 15 Dani Megert CLA 2015-03-25 09:54:16 EDT
David can we get this for 4.5? I assume it's a simple copy of the
API Tools Post-API Freeze Report, and
- rename it to API Tools Report  This report describes API changes since 4.4.x
- change the baseline to use 4.4.2
Comment 16 Markus Keller CLA 2015-12-18 07:09:35 EST
We're basically running blind now. We don't have API change reports in M20151217-0800 nor in I20151215-0800.

Bug 483591 makes the API Tools view almost unusable, so we currently have no efficient way to track API changes and breakages.

This cannot be difficult to fix. David, if you don't think you can get this running, please assign the bug to me.
Comment 17 David Williams CLA 2015-12-18 09:49:15 EST
I do not understand, on an intuitive level what is desired, and have a number of other things I have been told "are top priority" so if it is easy for you to do, as you think it would be for me, then by all means, please assign the bug to yourself and do it. 

I will not assign to you, it the off chance I get other tasks done and then have time to look at this and try to truly understand.
Comment 18 Dani Megert CLA 2015-12-18 09:52:02 EST
Also deprecation report should be there, see e.g.
http://archive.eclipse.org/eclipse/downloads/drops/R-3.8.2-201301310800/testResults.php
Comment 19 Sravan Kumar Lakkimsetti CLA 2017-05-25 08:10:35 EDT
Moving to 4.8.
Comment 20 Sravan Kumar Lakkimsetti CLA 2018-08-23 02:42:43 EDT
There are plans for this. Will revisit in 4.10
Comment 21 Sravan Kumar Lakkimsetti CLA 2018-12-04 07:09:01 EST
Moving out of 4.10. Please re triage appropriately
Comment 22 Eclipse Genie CLA 2020-11-24 01:31:30 EST
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. As such, we're closing this bug.

If you have further information on the current state of the bug, please add it and reopen this bug. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.