Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate ApiFileGenerationApplication #422

Merged
merged 1 commit into from
Dec 6, 2022
Merged

Deprecate ApiFileGenerationApplication #422

merged 1 commit into from
Dec 6, 2022

Conversation

vogella
Copy link
Contributor

@vogella vogella commented Dec 6, 2022

Eclipse platform migrated to Tycho for generating the API baseline. Yon also also add the generation to your Tycho build. Also platform is not using this application anymore it is now deprecated and may be deleted in the future-

org.eclipse.tycho tycho-apitools-plugin ${tycho.version} generate generate ${skipAPIDescription} ${project.artifactId}_${qualifiedVersion} laeubi marked this conversation as resolved.

@vogella vogella requested review from HannesWell and laeubi December 6, 2022 10:18
@vogella
Copy link
Contributor Author

vogella commented Dec 6, 2022

Did we also replace ApiAnalysisApplication with Tycho or only the API generation part?

@mickaelistria
Copy link
Contributor

Could this application log a message? An application is usually not consumed via API but using the launcher with the applicationId. Some consumers would still not be informed if we just deprecate the API.

@mickaelistria
Copy link
Contributor

Did we also replace ApiAnalysisApplication with Tycho or only the API generation part?

Not yet, only API generation has a good and complete replacement at the moment.

Eclipse platform migrated to Tycho for generating the API baseline.
Yon also also add the generation to your Tycho build.
Also platform is not using this application anymore it is now deprecated
and may be deleted in the future-

 </plugin>
			<plugin>
	            <groupId>org.eclipse.tycho</groupId>
				<artifactId>tycho-apitools-plugin</artifactId>
	            <version>${tycho.version}</version>
				<executions>
					<execution>
						<id>generate</id>
						<goals>
							<goal>generate</goal>
						</goals>
						<configuration>
                  			<skip>${skipAPIDescription}</skip>
                  			<projectName>${project.artifactId}_${qualifiedVersion}</projectName>
laeubi marked this conversation as resolved.
						</configuration>
					</execution>
				</executions>
			</plugin>
@vogella
Copy link
Contributor Author

vogella commented Dec 6, 2022

Could this application log a message? An application is usually not consumed via API but using the launcher with the applicationId. Some consumers would still not be informed if we just deprecate the API.

I added an error output message, which should be visible to any user.

Copy link
Contributor

@mickaelistria mickaelistria left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve that.
In general, I approve moving as much of Ant support out of PDE. If someone wants to ensure Ant build support, it would better fit in a separate project (I remember it used to be Eclipse Athena providing that, but since it dies long ago, there is apparently not so much interest).

@laeubi
Copy link
Contributor

laeubi commented Dec 6, 2022

I just wanted to note that this is actually not ant task the application was just previously called by ant (but you could have done this with other things as well).

@github-actions
Copy link

github-actions bot commented Dec 6, 2022

Test Results

     80 files       80 suites   17m 54s ⏱️
3 274 tests 3 250 ✔️ 24 💤 0
3 373 runs  3 349 ✔️ 24 💤 0

Results for commit 12cae44.

@laeubi
Copy link
Contributor

laeubi commented Dec 6, 2022

Did we also replace ApiAnalysisApplication with Tycho or only the API generation part?

This is work in progress see

@vogella vogella merged commit 58705e1 into eclipse-pde:master Dec 6, 2022
@vogella vogella deleted the api-generation-ant-task branch December 6, 2022 10:57
@vogella
Copy link
Contributor Author

vogella commented Dec 6, 2022

Did we also replace ApiAnalysisApplication with Tycho or only the API generation part?

This is work in progress see

Great. Once this is done, we should review which of the Ant Tasks from the org.eclipse.pde.api.tools.internal.tasks package are not used anymore by platform and deprecated these.

@mickaelistria
Copy link
Contributor

Thanks for the correction @laeubi ; I was mistaken with the other conversation. I'm then a bit skeptical that removing applications is a good idea. The benefit of applications is that they can easily be integrated with any tool: bash, Gradle, Tycho, Ant... without further integration effort; this seems important as we don't want to lock consumers of API Tools to 1 particular build tool or 1 particular process.
But as it's just a deprecation, it's all right and it's actually a good test. We may get attention from other consumers and their feedback will help to decide how to continue support of the API application or not.

Copy link
Member

@HannesWell HannesWell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.
And while it is right that applications give great flexibility, my guess is that there are not many, If no usages at all without Tycho. I don't think there are many people that build Eclipse Plugins without Tycho and therefore I think this applies to this app top.
But if I'm wrong the deprecation notice will hopefully encourage other users to let ist know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants