Skip to content

Latest commit

 

History

History
77 lines (46 loc) · 3.98 KB

README.md

File metadata and controls

77 lines (46 loc) · 3.98 KB
Raw

Xactus

About

Xactus is FINGO's open-source XPath 2.0 processing library based on the Eclipse's XPath 2.0 implementation from the Eclipse Web Tools Platform Project's.

Contributing

Pull requests are welcome. We will respond as much as possible. For major changes please open an issue first to discuss what you would like to do.

To protect the rights of others, we use the Developer Certificate of Origin. If you want to develop the project with us, please confirm authorship by signing-off your commits. The procedure is verified using Probot: DCO.

License

The library is published under the Eclipse Public License v2.0 license, a copy you will find in the license file. If you received this library from another party, conditions other than those stated here might apply. Please check it with your Redistributor.

Development

Building

  • ./gradlew jar - builds the library.
  • ./gradlew sourcesJar - builds sources JAR.
  • ./gradlew javadoc - builds Javadocs.
  • ./gradlew javadocJar - builds Javadoc JAR.

Running tests

  • ./gradlew test - run all tests excluding JUnit 3 test suites.
  • ./gradlew testSuite - runs JUnit 3 test suites only.

Releasing

Xactus is using Axion Release Plugin for the release process support. Please refer to Axion's documentation.

Publishing

General

There are a few publishing targets:

  • local folder ('build/repos/releases' and 'build/repos/snapshots'):

    ./gradlew publishMavenJavaPublicationToLocalRepository

  • M2 local cache:

    ./gradlew publishToMavenLocal

  • Maven Central (requires OSSRH credentials to be set - see below):

    ./gradlew publishMavenJavaPublicationToOSSRHRepository

PGP configuration

Publishing tasks require some project properties to be set:

  • pgpSecretKey - ascii-armored PGP secret key to sign the artifact.
  • pgpSecretKeyPassword - the password for the PGP secret key.
  • pgpKeyId (optional) - the id of the OpenPGP sub-key.

Specifying pgpSecretKey and pgpSecretKeyPassword causes the signing mechanism to use in-memory ascii armored keys or in-memory ascii-armored OpenPGP subkeys (when signing.pgp.keyId is set as well).

When neither of the pgpSecretKey and pgpSecretKeyPassword parameters are supplied then the default set of settings is taken into account.

Publishing to Maven Central

Command to publish Xactus to Maven Central:

  ./gradlew publishMavenJavaPublicationToOSSRHRepository

To publish an artifact to Maven Central OSSRH credentials need to be supplied in addition to the PGP configuration:

  • ossrhUserName - OSSRH username to be used to deploy the artifact.
  • ossrhPassword - password for the OSSRH user.

Links: