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

Consider japi-tracker integration into CI #27

Closed
imagejan opened this issue Dec 4, 2018 · 6 comments · Fixed by scijava/pom-scijava-base#17
Closed

Consider japi-tracker integration into CI #27

imagejan opened this issue Dec 4, 2018 · 6 comments · Fixed by scijava/pom-scijava-base#17

Comments

@imagejan
Copy link
Member

imagejan commented Dec 4, 2018

Consider integration of japi-tracker in continuous integration to monitor the API state of all components managed on the SciJava/ImageJ maven repository. The reports could be hosted as static webpages similar to the javadoc, e.g. at api-history.scijava.org or some such.

For libraries released to Maven Central, the reports exist here:

@imagejan
Copy link
Member Author

imagejan commented Mar 1, 2019

.. or revapi, as suggested by @ctrueden on the forum.

@imagejan
Copy link
Member Author

Happy to see that @frauzufall and @ctrueden seem to be working on something similar at the KNIME hackathon 🙂
https://gitter.im/knime-ip/hackathon-KNIME-2019?at=5d8739ebab4244767be45619

@frauzufall
Copy link
Member

Oh cool! On a first view the reports linked above look way better than what I tried.

@ctrueden
Copy link
Member

ctrueden commented Sep 23, 2019

Ah, thanks @imagejan, I had forgotten all about this. Sorry about that, @frauzufall. Was mostly @frauzufall working on it—I just posted a gist as a quick experiment to see if using javap directly would be reasonable. But of course a dedicated tool (not maintained by us) will be much better.

@frauzufall
Copy link
Member

frauzufall commented May 22, 2020

This might be simpler to integrate e.g. into the release script: https://revapi.org/modules/revapi-maven-plugin/. This plugin could also help us to make it impossible or very hard to break the API at all @ctrueden (thinking of the incubator strategy)

@imagejan
Copy link
Member Author

revapi-maven-plugin looks great!

I suggest adding a section like this to <pluginManagement> in pom-scijava (or pom-scijava-base?):

			<plugin>
				<groupId>org.revapi</groupId>
				<artifactId>revapi-maven-plugin</artifactId>
				<version>0.11.4</version>
				<dependencies>
					<dependency>
						<groupId>org.revapi</groupId>
						<artifactId>revapi-java</artifactId>
						<version>0.20.2</version>
					</dependency>
				</dependencies>
				<executions>
					<execution>
						<goals>
							<goal>check</goal>
						</goals>
					</execution>
				</executions>
			</plugin>

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 a pull request may close this issue.

3 participants