Skip to content

Latest commit

 

History

History
93 lines (58 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

93 lines (58 loc) · 1.81 KB

Contributing

Develop

  1. Fork this repo

  2. Build the project

# java >=8 required
export JAVA_HOME=/path/to/java8/home

mvn build
  1. Make a change

Fix a bug, add a feature, update the doc, etc

  1. Run the Tests
mvn test
  1. Create a Pull Request (PR)

Add yourself as a contributor

Once your PR has been merged, add the following comment to your PR:

@all-contributors please add @username for code and test!

Replace code and test with doc or test or infra or some combination depending on your contribution.

Package

Run the following to ensure the package step succeeds.

mvn clean test jacoco:report package

Publish to MavenCentral

Contributors are not responsible for deploying to mavencentral.

mvn clean dokka:javadocJar deploy

Maven Central

To publish a gpg key:

gpg --send-keys 5BE1414D5EAF81B48F2E77E1999F818C080AF9C1

where 5BE1414D5EAF81B48F2E77E1999F818C080AF9C1 is the public key

mvn clean test jacoco:report package deploy -DperformRelease=true

Publish to Github Packages

Note: This step can only be run by maintainers.

Add distributionManagement to pom.xml

  <distributionManagement>
    <repository>
      <id>github</id>
      <name>Carmine M DiMascio</name>
      <url>https://maven.pkg.github.com/cdimascio/dotenv-java</url>
    </repository>
  </distributionManagement>
# deploy to github packages
mvn deploy -Dregistry=https://maven.pkg.github.com/cdimascio -Dtoken=XXXX

https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages