Skip to content

Latest commit

 

History

History
183 lines (144 loc) · 7.19 KB

README.adoc

File metadata and controls

183 lines (144 loc) · 7.19 KB
Raw

mylyn-wikitext-repository

This repository contains my notes and tools to create a maven repository for the Mylyn Wikitext jars. This is a workaround for Bug 421551.

Usage

You can use Mylyn Wikitext jars (browse them in the mylyn-wikitext package) from my maven repository hosted on bintray:

http://dl.bintray.com/jmini/maven/

To use the Mylyn Wikitext jars in your pom, pick the interesting parts in from this snippet:

<project>
  <!-- ... -->
  <dependencies>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.asciidoc.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.confluence.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.core.ant</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.html.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.markdown.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core.ant</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.textile.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.tracwiki.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.mylyn.docs</groupId>
      <artifactId>org.eclipse.mylyn.wikitext.twiki.core</artifactId>
      <version>2.10.1.v20161129-1925</version>
    </dependency>
  </dependencies>

  <repositories>
    <repository>
      <id>bintray.jmini.maven</id>
      <url>http://dl.bintray.com/jmini/maven/</url>
    </repository>
  </repositories>
</project>

A simple example (pom file and simple java class) is presented in this blog post.

Versions

  • Mars.0 (24/06/2015), Version 2.5.0.v*

  • Mars.1 (02/10/2015), Version 2.6.0.v*

  • Mars.2 (26/02/2016), Version 2.7.0.v*

  • Neon.0 (22/06/2016), Version 2.9.0.v*

  • With Neon.1 the same version as with Neon.0 was released.

  • Neon.2 (21/12/2016), Version 2.10.0.v*

Remarks

Because the Idea of this repository is to consume mylyn-wikitext in a plain maven project (or maven plugin), only the core jars are published. In my opinion the ui jars are consumed in an Eclipse RCP context where building with Tycho and consuming the P2 repository is not a problem.

The Eclipse simultaneous release train (starting with Mars.0) was used as base to build the maven repository. This is why a jar like org.eclipse.mylyn.wikitext.commonmark is not available in the repository.

Examples

Check out the examples.

Setup in Eclipse IDE

There is an Eclipse Oomph Setup Task to import this project: MylynWikitextRepository.setup

Official maven repository

The Mylyn Wikitext project provides an official maven repository hosted by the Eclipse fundation:

https://repo.eclipse.org/content/repositories/mylyn-snapshots/

Please note that this repository contains only snapshot artifacts. A major difference is also that the dependencies declaration is not the same between the Eclipse Fundation repository and my repository. I consider my repository as much more user friendly.

Issue tracker / Get in touch

For this project (content of this repository and of the maven repository):

For the mylyn-wikitext project itself:

Notes

Description

This work rely on the Eclipse CBI aggregator tool. It does the convertion of the p2 repository into a maven repository. The *.aggr files are located in the aggregator project.

Before end 2016, the aggregator tool was named Eclipse b3 aggregator. The files using this version of the tool are using the extension *.b3aggr. Learn more about the transition in Bug 506726

Some help scripts written in Java are located in the javatools project.

Build

There is no automatic build at the moment. This section describes the manual steps requested to build the maven repository and to upload it to bintray.

  1. Open an *.aggr file with the "Aggregator Model Editor".

  2. Select the root node and run "Build Aggregation".

  3. In the created repository, the p2 files are not necessary:

    • {repository}/final/artifacts.jar

    • {repository}/final/content.jar

    • {repository}/final/p2.index

    • ..

  4. Zip the interesting parts of the "{repository}/final" folder. You should use the default Ant task provided in the build.xml file to do this.

  5. Upload this zip to bintray. To use the web UI, a version should exists in a package.