Contributing

Develop

1. Fork it

2. Build the project

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

mvn clean compile test

3. Make a change

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

4. Run the Tests

mvn test

5. Create a PR

Misc

Add yourself as a contributor

After your PR has been merged, add yourself as a contributor.

To do so, add a comment like the following on your PR:

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

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

Package

Contributors are not responsible for pushing packages to mavencentral and jcenter. Contributors are responsible for validating that the package step succeeds.

mvn clean package dokka:javadocJar

Publish to GitHub Packages

Add distributionManagement to pom.xml

  <distributionManagement>
    <repository>
      <id>github</id>
      <name>Carmine M DiMascio</name>
      <url>https://maven.pkg.github.com/cdimascio/dotenv-kotlin</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

# deploy to maven central
mvn clean package dokka:javadocJar deploy -DperformRelease=true

Go to SonaType: https://oss.sonatype.org/#stagingRepositories - select repository -> close -> (once closed) release

Publish raw artifacts / binaries

Generate

Generate signed artifacts locally

 mvn verify -P release-sign-artifacts -DperformRelease=true 

Publish to github release

gh release upload v6.4.2 target/*.jar.asc --clobber