Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.9 KB

Contributing to Krausening

Purpose

This document serves to provide necessary steps and information to contribute to the Krausening codebase. Documentation on the purpose and functionality of relevant source files is also covered to serve as priming context, prior to making contributions.

Releasing to Maven Central Repository

Krausening uses both the maven-release-plugin and the nexus-staging-maven-plugin to facilitate the release and deployment of new Krausening builds. In order to perform a release, you must:

  1. Obtain a JIRA account with Sonatype OSSRH and access to the org.technologybrewery.askllc project group

  2. Ensure that your Sonatype OSSRH JIRA account credentials are specified in your settings.xml:

<settings>
  <servers>
    <server>
      <id>ossrh</id>
      <username>ossrh-jira-id</username>
      <password>{encrypted-ossrh-jira-pwd}</password>
    </server>
  </servers>
</settings>
  1. Krausening Python requires a PyPI account with access to the krausening project and integrates into the maven-release-plugin's deploy phase to appropriately publish the package to PyPI. PyPI account credentials should be specified in your settings.xml under the <id>pypi</id> <server> entry:
<settings>
  <servers>
    <server>
      <id>pypi</id>
      <username>pypi-username</username>
      <password>{encrypted-pypi-password}</password>
    </server>
  </servers>
</settings>
  1. Install gpg and distribute your key pair - see here. OS X users may need to execute:
export GPG_TTY=`tty`;
  1. Execute mvn release:clean release:prepare, answer the prompts for the versions and tags, and perform mvn release:perform